afragen / wp-dismiss-notice
Library for time dismissible WordPress admin notices.
Installs: 20 968
Dependents: 3
Suggesters: 0
Security: 0
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/afragen/wp-dismiss-notice
Requires
- php: >=5.6
README
Add time dismissible admin notices to WordPress. Fork of https://github.com/w3guy/persist-admin-notices-dismissal
Instuctions
Initialize the class.
new \WP_Dismiss_Notice(); in your project.
Admin notice format.
You must add data-dismissible='<admin notice identifier>-<timeout>' to the admin notice div class. <timeout> values are from one day '1' to 'forever'. Default timeout is 14 days. The <admin notice identifier> should be some unique value based upon the admin notice that you wish to dismiss.
Example using a 14 day dismissible notice.
<div class="notice-warning notice is-dismissible" data-dismissible="my_admin_notice_<hash>-14">...</div>
Use the filter dismiss_notice_vendor_dir if you have set the composer vendor-dir to a non-standard location.
/**
* Filter composer.json vendor directory.
* Some people don't use the standard vendor directory.
*
* @param string Composer vendor directory.
*/
$vendor_dir = apply_filters( 'dismiss_notice_vendor_dir', '/vendor' );