wp admin notices

WP 管理员通知

一种创建可永久关闭的 WordPress 管理员通知的简单便捷的方法。除此之外，它还有一些很酷的功能：

• 仅对关闭通知的用户隐藏您的通知。
• 在特定情况下显示您的通知，例如当某些插件更新或激活时或在特定管理屏幕 ID 或 $_GET / $_POST 请求上，
• 创建您自己的特殊情况，在何处/何时应显示您的通知

简单使用

 add_action ( ' admin_notices ' , function () {
	$ notices_manager =  ThanksToIT  WPAN get_notices_manager ();
	$ notices_manager -> create_notice ( array (
		' id '         => ' my-notice ' ,
		' content '    => ' <p>My Notice</p> ' ,		
	) );
} );

注意：默认情况下，该库将使通知持续存在，这意味着用户关闭通知后不会再次显示通知，除非通知过期

初始化

为了使其完美工作，您需要像这样初始化它：

 add_action ( ' wp_ajax_ ' . ' tttwpan_dismiss_persist ' , array ( ' ThanksToITWPANNotices_Manager ' , ' ajax_dismiss ' ) );
add_action ( ' activated_plugin ' , array ( ' ThanksToITWPANNotices_Manager ' , ' set_activated_plugin ' ) );
add_action ( ' upgrader_process_complete ' , array ( ' ThanksToITWPANNotices_Manager ' , ' set_upgrader_process ' ), 10 , 2 );

在插件/主题上的任何其他挂钩之前进行这些调用非常重要。但不用担心，只有在必要时才会加载该库，因为它是在正确的挂钩上调用的

create_notice() 参数

• id （字符串）- 标识通知。
• type (String) - 通知的类型，用于通知类以设置其颜色。可能的值为'notice-info' 、 'notice-warning' 、 'notice-success' 、 'notice-error' 、 'notice-info' 。默认值为'notice-info' 。
• content （字符串）- 通知内容。
• 可驳回（布尔值）- 通知是否应可驳回。换句话说，如果你能关闭它。默认为true 。
• missal_expiration (int) - 通知将保持关闭状态的时间（以秒为单位）。大于零的值将使通知在关闭后仍然存在。如果设置为 0，它将不再保留。默认值为MONTH_IN_SECONDS 。
• display_on （数组） - 应显示通知的情况/时间。可能的值如下：
  • screen_id （数组）。在特定管理屏幕 ID 上显示通知。示例： 'screen_id' => array( 'plugins' ) 。
  • activated_plugin （数组）。显示某些插件是否被激活。示例： 'activated_plugin' => array('akismet/akismet.php') 。
  • update_plugin （数组）。显示某些插件是否更新。示例： 'updated_plugin' => array('akismet/akismet.php') 。
  • 请求（数组）- 显示 $_GET 或 $_POST 值。注意：它采用带有'key'和'value'参数的数组数组。示例： 'request' => array( array( 'key' => 'show_notice', 'value' => '1' ), ) 。
• keep_active_on (array) - 一旦满足 display_on 要求，保持通知始终打开，直到用户关闭通知。默认值为array( 'activated_plugin', 'updated_plugin' ) ，

示例

创建将关闭 1 周的通知

 add_action ( ' admin_notices ' , function () {
	$ notices_manager =  ThanksToIT  WPAN get_notices_manager ();
	$ notices_manager -> create_notice ( array (
		' id '         => ' 1-week-notice ' ,
		' content '    => ' <p>1 week notice</p> ' ,	
		' dismissal_expiration ' => WEEK_IN_SECONDS ,
	) );
} );

创建仅在插件页面上显示的通知

 add_action ( ' admin_notices ' , function () {
	$ notices_manager =  ThanksToIT  WPAN get_notices_manager ();
	$ notices_manager -> create_notice ( array (
		' id '         => ' plugins-page-notice ' ,
		' content '    => ' <p>plugins page notice</p> ' ,	
		' display_on ' => array (
			' screen_id ' => array ( ' plugins ' ),			
		)
	) );
} );

创建一条通知，该通知将在 Akismet 插件激活后显示

 add_action ( ' admin_notices ' , function () {
	$ notices_manager =  ThanksToIT  WPAN get_notices_manager ();
	$ notices_manager -> create_notice ( array (
		' id '         => ' akismet-notice ' ,
		' content '    => ' <p>Akismet notice</p> ' ,	
		' display_on ' => array (
			' activated_plugin ' => array ( ' akismet/akismet.php ' )
		)
	) );
} );

包安装（通过 Composer）

要安装此软件包，请编辑您的composer.json文件：

 {
    "require" : {
        "thanks-to-it/wp-admin-notices" : "dev-master"
    }
}

现在运行：

$ composer install