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