wp admin notices

Avisos de administración de WP

Una forma fácil y cómoda de crear avisos de administrador de WordPress que se pueden cerrar de forma persistente. Además de eso, tiene algunas características interesantes:

• Mantén tus avisos ocultos solo para el usuario que los cerró.
• Muestre su aviso en situaciones específicas, como cuando algún complemento se actualiza o activa o en identificadores de pantalla de administración específicos o en solicitudes $_GET / $_POST.
• Cree sus propios casos especiales donde/cuándo se debe mostrar su aviso

Uso sencillo

 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: De forma predeterminada, esta biblioteca hará que los avisos persistan, lo que significa que no se volverán a mostrar después de que el usuario los cierre, a menos que caduquen.

Inicialización

Para que funcione perfectamente, debes inicializarlo así:

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

Y es importante hacer estas llamadas antes de cualquier otro enlace en su complemento/tema. Pero no te preocupes, esta biblioteca se cargará sólo cuando sea necesario, ya que se llama en los ganchos adecuados.

parámetros create_notice()

• id (Cadena): identifica el aviso.
• tipo (Cadena): el tipo de aviso, utilizado en la clase de aviso para configurar su color. Los valores posibles son 'notice-info' , 'notice-warning' , 'notice-success' , 'notice-error' , 'notice-info' . El valor predeterminado es 'notice-info' .
• contenido (Cadena): contenido del aviso.
• descartable (booleano): si el aviso debe descartarse. En otras palabras, si puedes cerrarlo. El valor predeterminado es true .
• dismissal_expiration (int): cuánto tiempo en segundos permanecerá cerrado el aviso. Los valores mayores que cero harán que el aviso persista después del cierre. Si establece 0, ya no persistirá. El valor predeterminado es MONTH_IN_SECONDS .
• display_on (matriz): situaciones en las que/cuándo se debe mostrar el aviso. Valores posibles a continuación:
  • screen_id (matriz). Muestra el aviso en identificadores de pantalla de administrador específicos. Ejemplo: 'screen_id' => array( 'plugins' ) .
  • complemento_activado (matriz). Muestra si algún complemento se activa. Ejemplo: 'activated_plugin' => array('akismet/akismet.php') .
  • actualizado_plugin (matriz). Muestra si algún complemento se actualiza. Ejemplo: 'updated_plugin' => array('akismet/akismet.php') .
  • solicitud (matriz): se muestra en valores $_GET o $_POST. Nota: Se necesita una serie de matrices con parámetros 'key' y 'value' . Ejemplo: 'request' => array( array( 'key' => 'show_notice', 'value' => '1' ), ) .
• keep_active_on (matriz): mantiene el aviso siempre abierto una vez que se cumplen los requisitos de display_on, hasta que el usuario cierra el aviso. El valor predeterminado es array( 'activated_plugin', 'updated_plugin' ) ,

Ejemplos

Crea un aviso que estará cerrado 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 ,
	) );
} );

Cree un aviso que se mostrará solo en la página de complementos

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

Cree un aviso que se mostrará después de que se active el complemento 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 ' )
		)
	) );
} );

Instalación del paquete (a través de Composer)

Para instalar este paquete, edite su archivo composer.json :

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

Ahora ejecuta:

$ composer install