wp admin notices

Avisos de administração do WP

Uma maneira fácil e conveniente de criar avisos de administração do WordPress que podem ser fechados de forma persistente. Além disso, possui alguns recursos interessantes:

• Mantenha seus avisos ocultos apenas para o usuário que os fechou.
• Exiba seu aviso em situações específicas, como quando algum plugin é atualizado ou ativado ou em IDs de tela de administração específicos ou em solicitações $_GET/$_POST,
• Crie seus próprios casos especiais onde/quando seu aviso deve ser exibido

Uso Simples

 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> ' ,		
	) );
} );

Nota: Por padrão, esta biblioteca fará com que os avisos persistam, o que significa que eles não serão exibidos novamente após o usuário fechá-los, a menos que expirem

Inicialização

Para que funcione perfeitamente, você precisa inicializá- lo assim:

 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 );

E é importante fazer essas chamadas antes de qualquer outro gancho no seu plugin/tema. Mas não se preocupe, esta biblioteca será carregada somente quando for necessário, pois está sendo chamada nos ganchos apropriados

Parâmetros create_notice()

• id (String) - Identifica o aviso.
• type (String) - O tipo de aviso, utilizado na classe de aviso para configurar sua cor. Os valores possíveis são 'notice-info' , 'notice-warning' , 'notice-success' , 'notice-error' , 'notice-info' . O valor padrão é 'notice-info' .
• content (String) - Conteúdo do aviso.
• dispensável (Booleano) - Se o aviso deve ser dispensado. Em outras palavras, se você puder fechá-lo. O padrão é true .
• dispisal_expiration (int) - Quanto tempo em segundos o aviso permanecerá fechado. Valores maiores que zero farão com que o aviso persista após fechado. Se você definir 0, ele não persistirá mais. O padrão é MONTH_IN_SECONDS .
• display_on (array) - Situações onde/quando o aviso deve ser exibido. Valores possíveis abaixo:
  • screen_id (matriz). Exibe o aviso em IDs de tela de administrador específicos. Exemplo: 'screen_id' => array( 'plugins' ) .
  • plugin_ativado (matriz). Exibe se algum plugin for ativado. Exemplo: 'activated_plugin' => array('akismet/akismet.php') .
  • plugin_atualizado (matriz). Exibe se algum plugin for atualizado. Exemplo: 'updated_plugin' => array('akismet/akismet.php') .
  • request (array) - Exibido em valores $_GET ou $_POST. Nota: É necessária uma matriz de matrizes com parâmetros 'key' e 'value' . Exemplo: 'request' => array( array( 'key' => 'show_notice', 'value' => '1' ), ) .
• keep_active_on (array) - Mantém o aviso sempre aberto assim que os requisitos display_on forem atendidos, até que o usuário feche o aviso. O valor padrão é array( 'activated_plugin', 'updated_plugin' ) ,

Exemplos

Crie um aviso que ficará fechado por 1 semana

 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 ,
	) );
} );

Crie um aviso que será exibido apenas na página de plugins

 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 ' ),			
		)
	) );
} );

Crie um aviso que será exibido após a ativação do plugin 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 ' )
		)
	) );
} );

Instalação do pacote (via Composer)

Para instalar este pacote, edite seu arquivo composer.json :

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

Agora execute:

$ composer install