Plugin WordPress Piège-plateau partie 2: Développement d'un plugin-WordPresse-php.cn

Plugin WordPress Piège-plateau partie 2: Développement d'un plugin

Dans la première partie de ma série, une introduction à la buisaude de plugin WordPress, nous avons examiné comment le code est organisé dans la buissier. Pour continuer avec cette série, nous appliquerons ce que nous avons appris précédemment à créer un véritable plugin de travail. Nous allons jeter un œil à la rapidité avec laquelle nous pouvons mettre notre plugin opérationnel en utilisant le code de la passe-partout, avec le moins de travail possible.

Cet article se concentrera sur la création et l'activation du plugin, ainsi que sur le développement des fonctionnalités de face d'administration du plugin. Afin de suivre ce tutoriel, vous aurez besoin d'une compréhension de base de PHP et WordPress, ainsi que d'une connaissance pratique de l'API du plugin WordPress.

Les plats clés

Utilisez la binelle de plugin WordPress pour accélérer le processus de développement avec une approche structurée et organisée, assurant que les meilleures pratiques sont suivies.
Personnalisez le plugin en ajoutant une page d'options à l'aide de l'API des paramètres pour permettre aux utilisateurs de modifier des paramètres tels que la position d'affichage des avis et le nombre de jours après lequel un message est considéré comme obsolète.
Implémentez les fonctionnalités du plugin en enregistrant les paramètres, en ajoutant des champs de paramètres et en gérant la sauvegarde et la récupération de ces valeurs de paramètres à l'aide des classes et méthodes fournies dans la buissier.
Optimiser les fonctionnalités orientées administratives du plugin en créant une interface propre et conviviale pour la page des options, et assurez-vous que les paramètres sont correctement enregistrés et affichés.
Planifiez des améliorations supplémentaires telles que le nettoyage du code, l'internationalisation et la logique d'application plus sélective pour affiner l'efficacité du plugin et l'expérience utilisateur.

sur le plugin

Nous allons développer un plugin simple qui affichera le nombre de jours car un message spécifique a été mis à jour pour la dernière fois. Nous allons également offrir quelques personnalisations simples au plugin, permettant à l'utilisateur de choisir un nombre spécifique de jours après quoi un message sera considéré comme dépassé, ainsi que la position de l'avis dans le contenu du message.

Préparation du chaudr-plaque

Comme mentionné dans le premier article, nous pouvons soit télécharger une nouvelle copie de la passerelle et faire la recherche et nous remplacer, soit nous pouvons utiliser le générateur de buissier de plugin WordPress non officiel pour accélérer le processus. Utilisons le générateur pour notre plugin.

Rendez-vous sur le site Web du générateur de buissier de buissier WordPress et remplissez le formulaire avec les valeurs appropriées. Appelons simplement notre plugin «avis obsolète». Voici un échantillon de formulaire avec les champs remplis.

Plugin WordPress Piège-plateau partie 2: Développement d'un plugin

J'utilise une URL imaginaire pour l'URL du plugin qui est lié à un référentiel officiel. Ne vous inquiétez pas trop de ce genre de choses car nous pouvons toujours le modifier plus tard dans l'en-tête du plugin.

Cliquez sur le bouton "Build" et vous devriez obtenir une belle copie personnalisée de la binelle de plugin WordPress.

Installation et activation du plugin

L'archive zip générée contiendra les deux répertoires, actifs et tronc attendus. Nous n'allons pas utiliser l'itinéraire SymLink pour installer notre plugin, alors extrayez le dossier du coffre dans l'archive et copiez-le dans le répertoire WP-Content / Plugins.

Nous devons encore le renommer de manière appropriée pour éviter un conflit de dénomination avec d'autres plugins, nous renommerons donc le répertoire du tronc en passant par des notes obsolètes.

Si vous accédez maintenant à la section "Plugins installés" dans WP-Admin, bien sûr, vous verrez que votre plugin est sur la liste des plugins installés mais pas encore activés. Le générateur de chauffeur de plugin ne modifie rien en ce qui concerne la description du plugin, donc si nous voulons le modifier, nous pouvons simplement modifier la description dans le fichier de plugin principal, dans notre cas, Outdated-note.php.

Cliquez sur «Activer» pour activer votre nouveau plugin brillant. Rien ne changera sur votre site WordPress, alors ne vous inquiétez pas qu'il n'y ait rien à voir après l'activation du plugin.

Ajout d'une page d'options

Les développeurs de plugins fournissent généralement un moyen à l'utilisateur de personnaliser les paramètres du plugin. Cela peut être réalisé en utilisant l'API des paramètres fournis par WordPress. Voyons comment pouvons-nous intégrer nos propres paramètres dans le plugin.

En bref, nous allons permettre à l'utilisateur de choisir où l'avis apparaît, soit avant le contenu du message, soit après le contenu du message. En ce qui concerne le seuil de jours, l'utilisateur peut définir le nombre de jours avant qu'un message ne soit considéré comme obsolète. En utilisant cette information, nous allons modifier dynamiquement la classe de l'avis afin que nous puissions le coiffer différemment d'un article qui est toujours considéré comme frais.

Commençons par l'ajout d'une page d'options pour notre plugin.

Ouvrez la classe-Note-note-admin.php de la classe dans votre dossier d'administration. Nous devons modifier cette classe pour nous permettre d'enregistrer une page de paramètres pour notre plugin. Ajoutez cette méthode publique vers la fin de la classe.

<span>/**
</span><span>	 * Add an options page under the Settings submenu
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function add_options_page() {
</span>	
		<span>$this->plugin_screen_hook_suffix = add_options_page(
</span>			<span>__( 'Outdated Notice Settings', 'outdated-notice' ),
</span>			<span>__( 'Outdated Notice', 'outdated-notice' ),
</span>			<span>'manage_options',
</span>			<span>$this->plugin_name,
</span>			<span>array( $this, 'display_options_page' )
</span>		<span>);
</span>	
	<span>}</span>

Copier après la connexion

Une chose à noter est que nous utilisons des classes pour définir nos crochets, nous devons passer un tableau sous forme de tableau (,

Nous n'avons pas encore fini! Comme nous pouvons le voir, l'add_options_page nécessite une fonction de rappel valide, que nous n'avons pas encore définie dans notre classe Outdated_notice_admin. Ajoutons-le. Donc, tout ce que nous avons à faire pour notre fonction de rappel est d'inclure ce fichier.

<span>/**
</span><span>	 * Add an options page under the Settings submenu
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function add_options_page() {
</span>	
		<span>$this->plugin_screen_hook_suffix = add_options_page(
</span>			<span>__( 'Outdated Notice Settings', 'outdated-notice' ),
</span>			<span>__( 'Outdated Notice', 'outdated-notice' ),
</span>			<span>'manage_options',
</span>			<span>$this->plugin_name,
</span>			<span>array( $this, 'display_options_page' )
</span>		<span>);
</span>	
	<span>}</span>

Copier après la connexion

Cela devrait le faire. La dernière chose que nous devons faire maintenant est de le charger correctement en utilisant la classe de chargeur fournie dans le chauffeur. Ouvrez votre classe-Outdated-Notrice.php dans le dossier Inclut et ajoutez le crochet supplémentaire que nous avons défini plus tôt dans la méthode Define_admin_hooks. Le crochet d'action approprié à inclure sur notre page d'options est admin_menu alors ajoutons-le.

<span>/**
</span><span>	 * Render the options page for plugin
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function display_options_page() {
</span>		<span>include_once 'partials/outdated-notice-admin-display.php';
</span>	<span>}</span>

Copier après la connexion

Vous devriez maintenant voir un sous-menu supplémentaire «Avis obsolète» dans les paramètres. Vous pouvez accéder à la page d'options vides en vous rendant à l'URL http: // /wp-admin/options-general.php?page=outdated-note.

C'est une page vierge pour l'instant, alors commençons à remplir le fichier partiel avec une majoration appropriée.

Enregistrer, enregistrer et récupérer la valeur des paramètres

La page API des paramètres du Codex WordPress fournit une bonne explication sur la façon d'enregistrer nos propres paramètres, notamment en les affichant sur la page des options.

Voici une ventilation de ce que nous allons faire dans cette section:

Enregistrez le crochet auprès du chargeur de passe-partout
Enregistrer une section Paramètres
Enregistrer deux champs de paramètres (jours de seuil et position de texte)
Enregistrer les deux paramètres
remplir la page des options
Économiser et repeupler les champs pour l'affichage.

Enregistrez le crochet au chargeur de passe-partout

passons par toutes les étapes une par une.

Pour enregistrer une section Paramètres, nous devrons utiliser la fonction register_setting. Le crochet approprié pour initialiser cette fonction est admin_init. Ainsi, nous allons d'abord ajouter un autre crochet dans le chargeur de la bailli pour enregistrer nos paramètres dans la méthode Define_Admin_Hooks de notre classe de bobinage principale, classe Outdated_notice.

<span>$this->loader->add_action( 'admin_menu', $plugin_admin, 'add_options_page' );</span>

Copier après la connexion

Pour simplifier les choses et fournir un type de names de nom de base à nos noms d'options, nous allons ajouter une autre variable privée en plus de cette classe. Mettez cet extrait sur la classe Outdated_notice_Admin.

<span>$this->loader->add_action( 'admin_init', $plugin_admin, 'register_setting' );</span>

Copier après la connexion

À partir de maintenant, nous allons constituer cette valeur à tout ce qui est lié à nos options.

La prochaine chose consiste à enregistrer réellement la section Paramètres, le champ des paramètres et les paramètres individuels. Ouvrez à nouveau la classe Outdated_notice_Admin et ajoutez la méthode publique Register_Setting dans cela.

Enregistrer une section Paramètres

Dans la méthode Public Register_Setting, nous allons enregistrer une section Paramètres. Je ne plongerai pas trop dans les différentes fonctions et API pour ce faire car le codex a déjà fourni suffisamment d'informations pour commencer. Comme les paramètres de nos plugins sont relativement simples, nous allons enregistrer une seule section.

Cet extrait nous permettra d'enregistrer une section «Générale» pour notre page d'options à l'aide de la fonction add_settings_section.

<span>/**
</span><span>	 * Add an options page under the Settings submenu
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function add_options_page() {
</span>	
		<span>$this->plugin_screen_hook_suffix = add_options_page(
</span>			<span>__( 'Outdated Notice Settings', 'outdated-notice' ),
</span>			<span>__( 'Outdated Notice', 'outdated-notice' ),
</span>			<span>'manage_options',
</span>			<span>$this->plugin_name,
</span>			<span>array( $this, 'display_options_page' )
</span>		<span>);
</span>	
	<span>}</span>

Copier après la connexion

Remarquez que nous sommes en cours sur notre nom de section avec la variable $ option_name pour éviter les conflits avec d'autres plugins. Le rappel peut être utilisé pour fournir des informations supplémentaires sur notre section, ce qui est exactement ce que nous voulons.

Nous allons ajouter une autre méthode publique, outdated_notice_general_cb qui fait écho aux informations de base sur cette section.

<span>/**
</span><span>	 * Render the options page for plugin
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function display_options_page() {
</span>		<span>include_once 'partials/outdated-notice-admin-display.php';
</span>	<span>}</span>

Copier après la connexion

Enregistrer deux champs de paramètres (jours de seuil et position de texte)

La partie suivante de l'API des paramètres que nous devons utiliser consiste à enregistrer le champ réel à rendre sur la page Options. Cela peut être réalisé en utilisant la fonction add_settings_field.

Nous utiliserons les boutons radio pour la configuration de position du texte. Cela se fait en ajoutant ce code à la fonction register_setting que nous avons.

<span>$this->loader->add_action( 'admin_menu', $plugin_admin, 'add_options_page' );</span>

Copier après la connexion

Nous devons nous assurer que le cinquième argument de add_settings_field pointera vers la section des paramètres corrects que nous avons enregistrés auparavant ou que nous pourrions ne pas voir le champ sur notre page d'options.

Ce n'est pas encore fait. Nous devons fournir la fonction de rappel qui rendra le balisage réel de nos boutons radio. Dans notre fonction Outdated_notice_Position_CB, nous devons inclure ce bloc de code:

<span>$this->loader->add_action( 'admin_init', $plugin_admin, 'register_setting' );</span>

Copier après la connexion

La deuxième option de seuil de jour peut être configurée à l'aide d'une entrée de texte normale. Nous allons donc enregistrer un autre champ de paramètres:

<span>/**
</span><span>	 * The options name to be used in this plugin
</span><span>	 *
</span><span>	 * <span>@since  	1.0.0
</span></span><span>	 * <span>@access 	private
</span></span><span>	 * <span>@var  	<span>string</span> 		$option_name 	Option name of this plugin
</span></span><span>	 */
</span>	<span>private $option_name = 'outdated_notice';</span>

Copier après la connexion

Encore une fois, nous devons également fournir une fonction de rappel qui rendra notre champ de texte.

<span>// Add a General section
</span>	<span>add_settings_section(
</span>		<span>$this->option_name . '_general',
</span>		<span>__( 'General', 'outdated-notice' ),
</span>		<span>array( $this, $this->option_name . '_general_cb' ),
</span>		<span>$this->plugin_name
</span>	<span>);</span>

Copier après la connexion

Enregistrez les paramètres

Enfin, nous devons enregistrer le nom des options que nous allons utiliser afin qu'il puisse être reconnu dans WordPress. Étant donné que nous utilisons deux noms d'options différents, outdated_notice_position et outdated_notice_day, nous allons les enregistrer tous les deux en utilisant la fonction register_setting.

<span>/**
</span><span>	 * Render the text for the general section
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function outdated_notice_general_cb() {
</span>		<span>echo '<p>' . __( 'Please change the settings accordingly.', 'outdated-notice' ) . '</p>';
</span>	<span>}</span>

Copier après la connexion

Remarquez que le troisième paramètre pour la fonction register_setting est un rappel de désinfection. Bien qu'il soit facultatif, il est toujours utile de s'assurer que les valeurs d'entrée sont désinfectées avant d'être enregistrées dans la base de données.

Pour la désinfection d'une journée, nous utiliserons la fonction PHP intégrée, Intval car il suffit dans notre cas. Quant à la position de préavis de texte, nous allons définir notre propre fonction de rappel de désinfection, qui permettra uniquement de l'enregistrer dans la base de données. Ceci est particulièrement utile lorsque l'on traite des options limitées à des valeurs spécifiques, comme dans ce cas où nous n'acceptons que deux valeurs, qui sont avant et après, notre rappel de désinfection devra donc s'assurer que si la valeur n'est pas une partie de Celles-ci, elles ne seront pas enregistrées dans la base de données.

Voici une fonction de rappel de désinfection simple pour y parvenir:

<span>/**
</span><span>	 * Add an options page under the Settings submenu
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function add_options_page() {
</span>	
		<span>$this->plugin_screen_hook_suffix = add_options_page(
</span>			<span>__( 'Outdated Notice Settings', 'outdated-notice' ),
</span>			<span>__( 'Outdated Notice', 'outdated-notice' ),
</span>			<span>'manage_options',
</span>			<span>$this->plugin_name,
</span>			<span>array( $this, 'display_options_page' )
</span>		<span>);
</span>	
	<span>}</span>

Copier après la connexion

remplir la page des options

Une fois que nous avons terminé avec l'enregistrement de tous les paramètres connexes, nous devons maintenant nous assurer que notre page d'options est correctement rendu. Puisque nous utilisons la façon WordPress d'enregistrer nos champs et nos paramètres, cette tâche est particulièrement simple.

Ouvrez le NOTICE-ADMIN-DISPLAY.PHP OUTDAT. Voici comment nous pouvons rendre la page d'options en fonction des paramètres que nous avons enregistrés auparavant.

<span>/**
</span><span>	 * Render the options page for plugin
</span><span>	 *
</span><span>	 * <span>@since  1.0.0
</span></span><span>	 */
</span>	<span>public function display_options_page() {
</span>		<span>include_once 'partials/outdated-notice-admin-display.php';
</span>	<span>}</span>

Copier après la connexion

Avec une combinaison simple de fonctions do_settings_sections et sections_fields, votre page d'options est effectuée en un rien de temps.

Prenons une pause et rafraîchissons la page des options.

Économiser et repeupler les champs

Essayez de remplir certaines valeurs et enregistrez le formulaire. Vous devriez obtenir l'avis «Paramètres enregistrés». mais rien s'est produit. Laissez essayer de faire un var_dump sur nos deux options. Placez cela quelque part dans la fonction connexe.

<span>$this->loader->add_action( 'admin_menu', $plugin_admin, 'add_options_page' );</span>

Copier après la connexion

Nous devons récupérer certaines valeurs de la base de données, selon l'exemple ci-dessous:

<span>$this->loader->add_action( 'admin_init', $plugin_admin, 'register_setting' );</span>

Copier après la connexion

Cela signifie que notre formulaire fonctionne très bien, donc la seule chose qui reste à faire est d'afficher la valeur actuelle dans le champ de texte, et de vous assurer que le bouton radio correct est vérifié.

Abordons d'abord les boutons radio. En tant que raccourci, nous allons simplement utiliser la fonction vérifiée fournie par WordPress pour marquer la valeur sélectionnée précédemment. Notre Outdated_notice_Position_CB aura besoin de modifications.

Voici un extrait mis à jour pour le rappel.

<span>/**
</span><span>	 * The options name to be used in this plugin
</span><span>	 *
</span><span>	 * <span>@since  	1.0.0
</span></span><span>	 * <span>@access 	private
</span></span><span>	 * <span>@var  	<span>string</span> 		$option_name 	Option name of this plugin
</span></span><span>	 */
</span>	<span>private $option_name = 'outdated_notice';</span>

Copier après la connexion

Maintenant, chaque fois que nous modifions la valeur des deux champs, il se reflétera correctement dans la page Options.

Améliorations supplémentaires

Ce n'est en aucun cas complet. Nous pouvons toujours améliorer la fonctionnalité face à l'administration de ce plugin. Certaines des choses auxquelles je peux penser sont:

CODE CLASTUP - WordPress Plugin Playplate est livré avec beaucoup de fonctionnalités utiles, mais dans notre cas, le côté administrateur, CSS et JS est complètement inutile. Nous pouvons toujours supprimer cela de notre base de code pour le rendre plus petit.
i18n (internationalisation) Prêt - Bien que nous utilisons largement les __ () et _e () dans notre plugin, nous ne passons pas vraiment par le processus i18n réel. Je ne couvrirai pas le processus ici car ce sujet a été discuté assez largement sur SitePoint, par exemple dans cet article.
Sélection plus fine - Comme notre implémentation va être appliquée à tous les articles, nous pouvons l'optimiser davantage pour être appliqué à un message dans une certaine catégorie, ou des articles qui contiennent des balises spécifiques.

Le code complet peut être affiché à partir de ce référentiel GitHub, dans la branche de la partie-2.

Conclusion

Nous avons créé un plugin avec des fonctionnalités de base de l'administrateur en enregistrant les paramètres associés et en créant une page d'options pour que l'utilisateur personnalise notre plugin. Dans un temps relativement court en utilisant la buissier debout du plugin WordPress, nous l'avons réalisé sans compromettre la qualité du code tout en adhérant aux meilleures pratiques recommandées par WordPress.

Restez à l'écoute pour la prochaine partie de la série où nous ferons le côté face au public du plugin pour afficher l'avis approprié à l'intérieur du contenu du message.

Des questions fréquemment posées sur le développement d'un plugin WordPress avec chauffeur

Quelle est la bailluerplate de plugin WordPress et pourquoi dois-je l'utiliser?

La baillire de plugin WordPress est un framework standardisé, organisé et orienté objet pour la construction de plugins WordPress de haute qualité. Il fournit une structure claire et cohérente facile à comprendre et à travailler. L'utilisation de cet passe-partout peut vous faire gagner beaucoup de temps et d'efforts pour configurer la structure de base d'un plugin. Il garantit également que votre plugin suit les normes de codage WordPress et les meilleures pratiques, qui peuvent aider à prévenir les bogues et les problèmes de compatibilité.

Comment puis-je commencer avec le buisaule du plugin WordPress?

Pour commencer Avec la boileuse-plaque de plugin WordPress, vous devez d'abord le télécharger à partir de son référentiel GitHub. Après le téléchargement, vous pouvez renommer le répertoire et les fichiers de la passerelle pour correspondre au nom de votre plugin. Ensuite, vous pouvez commencer à développer votre plugin en ajoutant vos propres fonctionnalités personnalisées à la structure existante de la baillit.

Quels sont les principaux composants du buissier de chauffage du plugin WordPress?

Le boiard-plaque de plugin WordPress est en plusieurs composants principaux. Il s'agit notamment du fichier de plugin, qui contient l'en-tête du plugin et la classe de chargeur; Le répertoire inclut, qui contient la classe de plugin de base et d'autres fichiers liés aux fonctionnalités; le répertoire administrateur, qui contient des fichiers liés aux fonctionnalités spécifiques à l'administrateur du plugin; et le répertoire public, qui contient des fichiers liés aux fonctionnalités accessibles au public du plugin.

Comment ajouter ma propre fonctionnalité à la baillerplate de plugin WordPress?

pour ajouter vos propres fonctionnalités à La bailLotplate de plugin WordPress, vous pouvez créer de nouvelles classes dans le répertoire incluse. Ces classes devraient étendre la classe de base fournie par la passerelle. Vous pouvez ensuite ajouter vos propres méthodes à ces classes pour implémenter les fonctionnalités souhaitées. Vous pouvez également modifier les classes et méthodes existantes au besoin.

Comment gérer les paramètres du plugin dans la bailLotplate de plugin WordPress?

La baillerplate de plugin WordPress fournit une classe pour gérer les paramètres du plugin. Cette classe comprend des méthodes pour enregistrer les paramètres, afficher les champs de paramètres et les valeurs des paramètres de désinfecter. Vous pouvez utiliser cette classe comme point de départ pour implémenter vos propres fonctionnalités de paramètres.

Comment ajouter des fonctionnalités spécifiques à l'administrateur à mon plugin?

Pour ajouter des fonctionnalités spécifiques à l'administrateur à votre plugin, vous pouvez utiliser les classes et méthodes fournies dans le répertoire administrateur de la plaqueau de plugin WordPress. Ce répertoire comprend des classes de création de pages d'administration, d'ajouter des champs de paramètres et de gérer les soumissions de formulaires.

Comment ajouter des fonctionnalités accessibles au public à mon plugin?

pour ajouter des fonctionnalités accessibles au public à votre Plugin, vous pouvez utiliser les classes et méthodes fournies dans le répertoire public de la baillire de plugin WordPress. Ce répertoire comprend des classes pour les scripts et les styles d'embouche internationalisation. Cette classe comprend des méthodes de chargement du domaine de texte du plugin, qui permet à votre plugin d'être traduit en différentes langues.

Comment gérer les demandes AJAX dans mon plugin?

La boiffe de plugin WordPress inclut des classes pour gérer les demandes AJAX. Ces classes incluent des méthodes pour enregistrer les actions AJAX, la gestion des demandes AJAX et l'envoi de réponses AJAX.

Comment déboguer mon plugin lors de l'utilisation du bobinage du plugin WordPress?

Débogue de votre plugin lors de l'utilisation du WordPresspress? Plugin Plagin Playplate peut être effectué de plusieurs manières. Une méthode courante consiste à utiliser la constante WP_debug dans votre fichier wp-config.php. Cela affichera des erreurs, des avis et des avertissements PHP. Vous pouvez également utiliser divers plugins de débogage disponibles pour WordPress, ou utiliser la fonctionnalité de journalisation d'erreur intégrée de PHP.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!