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 (文字列) - 色を設定するために通知クラスで使用される通知のタイプ。可能な値は'notice-info' 、 'notice-warning' 、 'notice-success' 、 'notice-error' 、 'notice-info'です。デフォルト値は'notice-info'です。
• content (文字列) - 通知内容。
• dismissible (ブール値) - 通知を無視できるかどうか。つまり、閉めることができれば。デフォルトはtrueです。
• dismissal_expiration (int) - 通知を閉じたままにしておく秒数。ゼロより大きい値を指定すると、通知が閉じられた後も保持されます。 0 を設定すると、永続化されなくなります。デフォルトはMONTH_IN_SECONDSです。
• display_on (配列) - 通知を表示する場所/タイミング。以下の可能な値:
  • screen_id (配列)。特定の管理画面IDに通知を表示します。例: 'screen_id' => array( 'plugins' ) 。
  • active_plugin (配列)。一部のプラグインが有効化された場合に表示されます。例: 'activated_plugin' => array('akismet/akismet.php') 。
  • updated_plugin (配列)。一部のプラグインが更新された場合に表示されます。例: 'updated_plugin' => array('akismet/akismet.php') 。
  • request (配列) - $_GET または $_POST 値を表示します。注: これは、 'key'パラメータと'value'パラメータを持つ配列の配列を受け取ります。例: 'request' => array( array( 'key' => 'show_notice', 'value' => '1' ), ) 。
• keep_active_on (配列) - 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