# WP Admin Notices
\nA Wordpress developer's plugin that makes adding notices less painful. I felt a need for something like this while working on a project and decided to make one.<\/p>\n
### Setup Using this code as a plugin is simple - just add folder to wp-content\/plugins folder and turn it in the admin panel. For multisite turn this plugin network wide (if you want to have multisite funcionality of course).<\/p>\n ### Usage<\/p>\n Plugin provides a very simple API, althought I reccomend using defined classes. ##### Arguments: #### That should be enough to use this plugin, more info below: ### That's all.
\nAlthought this code can be used as a plugin, I reccomend using it within your own plugin, just include admin-notices.php<\/code> in your code - otherwise if user accidently turns off this plugin your code will produce errors.<\/p>\n
\n##### Functions (wrappers for creating objects):
\n- single site (not multisite) functions:
\n - add_user_notice( int $user_id, string $content [, array $args ] )<\/code>
\n - add_current_user_notice( string $content [, array $args ] )<\/code>
\n - add_users_notice( array $users_ids, string $content [, array $args ] )<\/code>
\n- multisite functions:
\n - mu_add_user_notice( int $user_id, string $content [, array $args ] )<\/code>
\n - mu_add_current_user_notice( string $content [, array $args ] )<\/code>
\n - mu_add_users_notice( array $users_ids, string $content [, array $args ] )<\/code><\/p>\n
\n- $content<\/code> - Notice content. It gets wrapped in paragraph. Must be a string.
\n- $args<\/code> - General arguments in an associative array. Possible are:
\n - user_id<\/code> - User's ID for who you want to display notice. By default is set to current user id
\n - type<\/code> - Notice's type. Possible are:
\n - "success"<\/code> (green)
\n - "error"<\/code> (red)
\n - "warning"<\/code> (orange)
\n - _[default]_ "info"<\/code> (blue)
\n - "blank"<\/code> (no color)
\n - place<\/code> - Determines where the notice should be displayed. For now the possibilities are rather small:
\n - _[default]_ "all"<\/code> - notice is displayed everywhere on the admin panel
\n - post_id)<\/code> - notice is displayed on edit screen of a post of this id (works with products as well). Must be an intiger
\n - page_name<\/code> - id of an admin page (contained by WP_Screen object)
\n - display<\/code> - Determines how notice should be displayed:
\n - until_closed<\/code> - Notice is displayed on the refreshes until gets deleted by link under it. Useful when you want to be sure that user has noticed your message
\n - _[default]_ "once"<\/code> - Notice is displayed just once and can be closed by X button<\/p>\n
\n###### Deleting all notices
\nYou can delete all user notices by using Admin_Notice::delete_all_user_notices( int $user_id )<\/code> for single sites and MU_Admin_Notice::delete_all_user_notices( int $user_id )<\/code> if you want to remove global user notices.
\n###### Tests
\nYou can remove comment in admin-notices.php saying "ONLY FOR TESTS" to launch test. Make sure you comment it again after the code gets executed (on viewing admin panel).<\/p>\n
\nI hope someone finds it useful :)\n<\/p>","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/65474","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=65474"}],"author":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/solpatium"}],"wp:attachment":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=65474"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=65474"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=65474"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=65474"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=65474"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=65474"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}