Il y a quelque temps, nous avons vu comment créer facilement un simple plugin WordPress. Dans ce petit tutoriel je vais vous montrer comment créer un menu dans l’admin WordPress pour votre Plugin.
Préambule
Bien évidement, il vous faut un minimum de notion en PHP et en HTML pour comprendre les informations qui vont suivre dans ce tutoriel WordPress.
Tout d’abord si vous n’avez jamais créé de plugin merci de lire en premier cet article « comment créer facilement un simple plugin WordPress ». Pour rappel un plugin, ou en français appelé « extension », permet de rajouter de nouvelles fonctionnalités à WordPress. Il en existe des milliers téléchargeables sur le site officiel de WordPress.
Pensez quand vous faite un plugin à sa traduction. Ce n’est pas l’objet de ce tutoriel toutefois, on vous conseille la lecture de cet article qui vous fait un tour d’ensemble de ce qu’il faut faire : https://boiteaweb.fr/traduction-wordpress-vous-faites-fausse-route-8518.html
Pour qu’un utilisateur puisse depuis l’administration de WordPress accéder aux fonctions de votre plugin: il lui faut avoir un élément de menu sur la barre latérale. Ceci est utile aussi pour permettre à l’administrateur d’un site WordPress de configurer votre plugin.
Pour ce faire, nous devons dans le code du plugin nous connecter « à l’action » où le menu administrateur est chargé. Lorsque WordPress charge une page, elle s’exécute à travers un ensemble d’actions auxquelles nous pouvons nous connecter avec la fonction « add_action ».
Ci-contre vous avez les menus de la barre latérale de votre administration de site WordPress. C’est ce que vous voyez de base quand vous installer un WordPress. A ce stade celui-ci ne contient pas de plugin actif.
C’est à cette barre latérale que nous allons ajouter notre menu de Plugin. Dans notre exemple ci-dessous nous avons pris el partie de n’ajouter qu’un menu mais vous pouvez bien évidement ajouter également un sous-menu.
Code et explications
Dans le code suivant, nous créons un élément de menu dans le panneau d’administration qui nous amène à une page qui dit « Salut tous le monde! »:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<?php /* Plugin Name: Test Plugin Description: un plugin de test pour l’ajout d’un menu admin WordPress Author: WPN Version: 0.1 */ add_action('admin_menu','test_plugin_setup_menu'); functiontest_plugin_setup_menu(){ add_menu_page('Test Plugin Page', 'Test Plugin', 'manage_options', 'test-plugin', 'test_init' ); } functiontest_init(){ echo"<h1>Salut tous le monde!</h1>"; } ?> |
Examinons les fonctions que nous avons misent dans le code.
En ligne 8 vous trouvez celle-ci:
|
1 |
Add_action ('admin_menu', 'test_plugin_setup_menu'); |
Ici, nous nous déclenchons une action dans WordPress au moment où la barre de menu sur le panneau d’administration commence à se charger. On indique à WordPress que nous voulons exécuter la fonction ‘test_plugin_setup_menu‘, qui est quelques lignes plus bas dans le code sur la ligne 11.
En ligne 10 on déclare la fonction en php que l’on souhaite exécuter et qui porte le nom de « test_plugin_setup_menu »
C’est en ligne 11 que WordPress va aller chercher les informations nécessaires pour notre menu (cf ci-dessous)
|
1 |
Add_menu_page ('Test Plugin Page', 'Test Plugin', 'manage_options', 'test-plugin', 'test_init'); |
La première option ‘Test Plugin Page‘ est le titre de notre page d’options.
Le deuxième paramètre ‘Test Plugin‘ est l’étiquette de notre panneau d’administration.
Le troisième paramètre détermine quels utilisateurs peuvent voir l’option en limitant l’accès à certains utilisateurs avec certaines capacités.
‘test-plugin‘ est le « slug » qui sert à identifier le menu.
Le paramètre final ‘test_init‘ est le nom de la fonction que nous appelons lorsque l’option est sélectionnée. Cela nous permet d’ajouter du code à la sortie HTML dans notre page. Dans ce cas, nous écrivons simplement «Salut tous le monde!».
En ligne 14, on déclare la fonction qui doit être exécutée par la sélection du menu. Puis en ligne 15 on indique ce qu’elle contient. Dans notre cas en l’occurrence on affiche juste un message. Pour votre besoin c’est là par exemple où vous allez mettre votre code pour la page de configuration de votre plugin.
Voila vous connaissez maintenant les bases pour faire un menu dans l’administration de WordPress pour votre plugin. Dans ce tutoriel pour simplifier la compréhension nous avons uniquement créé un menu basique. Vous pouvez bien sûr ajouter dans votre code de quoi mettre des sous menu. Pour aller plus loin, je vous conseille de lire la page du codex pour la fonction «Add_menu_page».
