wp admin notices

Уведомления администратора WP

Простой и удобный способ создания уведомлений администратора WordPress, которые можно постоянно закрывать. Кроме того, у него есть несколько интересных функций:

• Держите свои уведомления скрытыми только для пользователя, который их закрыл.
• Отображайте уведомления в определенных ситуациях, например, когда какой-либо плагин обновляется или активируется, или при определенных идентификаторах экрана администратора, или при запросах $_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 (String) — содержимое уведомления.
• Disabled (Boolean) — если уведомление должно быть отклонено. Другими словами, если вы можете закрыть его. По умолчанию true .
• ignore_expiration (int) — как долго в секундах уведомление будет оставаться закрытым. Если значения больше нуля, уведомление будет сохраняться после закрытия. Если вы установите 0, оно больше не будет сохраняться. По умолчанию — MONTH_IN_SECONDS .
• display_on (массив) — ситуации, когда/где должно отображаться уведомление. Возможные значения ниже:
  • screen_id (массив). Отображает уведомление для определенных идентификаторов экрана администратора. Пример: 'screen_id' => array( 'plugins' ) .
  • активированный_плагин (массив). Отображается, если какой-либо плагин активирован. Пример: 'activated_plugin' => array('akismet/akismet.php') .
  • обновленный_плагин (массив). Отображается, если какой-либо плагин обновляется. Пример: 'updated_plugin' => array('akismet/akismet.php') .
  • запрос (массив) — отображается для значений $_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