wp admin notices

Avis d'administration WP

Un moyen simple et pratique de créer des notifications d’administrateur WordPress qui peuvent être fermées de manière persistante. En plus de cela, il possède quelques fonctionnalités intéressantes :

• Gardez vos notifications cachées uniquement pour l'utilisateur qui les a fermées.
• Affichez votre avis sur des situations spécifiques, comme lorsqu'un plugin est mis à jour ou activé ou sur des identifiants d'écran d'administrateur spécifiques ou sur des requêtes $_GET / $_POST,
• Créez vos propres cas particuliers où/quand votre avis doit être affiché

Utilisation simple

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

Remarque : Par défaut, cette bibliothèque fera persister les notifications, ce qui signifie qu'elles ne seront plus affichées après que l'utilisateur les aura fermées, à moins qu'elles n'expirent.

Initialisation

Afin de le faire fonctionner parfaitement, vous devez l' initialiser comme ceci :

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

Et il est important de passer ces appels avant tout autre hook sur votre plugin/thème. Mais ne vous inquiétez pas, cette bibliothèque ne sera chargée que lorsque cela sera nécessaire, car elle est appelée sur les hooks appropriés.

Paramètres create_notice()

• id (String) - Identifie l'avis.
• type (String) - Le type d'avis, utilisé sur la classe d'avis afin de configurer sa couleur. Les valeurs possibles sont 'notice-info' , 'notice-warning' , 'notice-success' , 'notice-error' , 'notice-info' . La valeur par défaut est 'notice-info' .
• content (String) - Aviser le contenu.
• révocable (booléen) - Si l'avis doit être rejeté. En d’autres termes, si vous pouvez le fermer. La valeur par défaut est true .
• dismissal_expiration (int) - Combien de temps en secondes l'avis restera fermé. Les valeurs supérieures à zéro feront persister l'avis après la fermeture. Si vous définissez 0, il ne persistera plus. La valeur par défaut est MONTH_IN_SECONDS .
• display_on (array) - Situations où/quand l'avis doit être affiché. Valeurs possibles ci-dessous :
  • screen_id (tableau). Affiche l'avis sur des identifiants d'écran d'administrateur spécifiques. Exemple : 'screen_id' => array( 'plugins' ) .
  • activé_plugin (tableau). S'affiche si un plugin est activé. Exemple : 'activated_plugin' => array('akismet/akismet.php') .
  • update_plugin (tableau). S'affiche si un plugin est mis à jour. Exemple : 'updated_plugin' => array('akismet/akismet.php') .
  • request (array) - S'affiche sur les valeurs $_GET ou $_POST. Remarque : Il prend un tableau de tableaux avec les paramètres 'key' et 'value' . Exemple : 'request' => array( array( 'key' => 'show_notice', 'value' => '1' ), ) .
• keep_active_on (array) - Conserve la notification toujours ouverte une fois que les exigences display_on sont remplies, jusqu'à ce que l'utilisateur ferme la notification. La valeur par défaut est array( 'activated_plugin', 'updated_plugin' ) ,

Exemples

Créer un avis qui sera fermé pendant 1 semaine

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

Créez un avis qui sera affiché sur la page des plugins uniquement

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

Créez un avis qui sera affiché après l'activation du 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 ' )
		)
	) );
} );

Installation du package (via Composer)

Pour installer ce package, modifiez votre fichier composer.json :

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

Maintenant, exécutez :

$ composer install