Créer une extension widget en PHP

Configurer l’extension

Pour créer un widget, procédez comme pour toute extension en créant un sous-dossier au dossier wp-content/plugins et donnez-lui un nom. Pour l’exercice, appelez-le « widget-post ».

À l’intérieur du dossier widget-post, créez un fichier widget-post.php. Insérez dans le dossier les fichiers readme.txt, licence.txt et index.php (vide), si vous le souhaitez.

En haut du fichier widget-post.php, ajoutez en en-tête un commentaire avec les informations sur l’extension, et activez l’extension. Puis, vérifiez qu’elle apparaît bien dans l’administration avec les bonnes informations.

Le commentaire est le suivant :

<?php  
/*  
Plugin Name: Widget post   
Description: widget permettant l'affichage d'une liste d'articles 
selon la catégorie.  
Version: 1.0  
License: GPLv2  
This program is free software; you can redistribute it and/or  
modify it under the terms of the GNU General Public License  
as published by the Free Software Foundation; either version 2  
of the License, or (at your option) any later version.  
  
This program is distributed in the hope that it will be useful,  
but WITHOUT ANY WARRANTY; without even the implied warranty of  
MERCHANTABILITY or FITNESS...

La classe WP_Widget

L’API des widgets de WordPress permet de gérer, créer, modifier des widgets grâce à plusieurs méthodes. Elle permet également d’étendre la classe WP_Widget, pour créer des widgets d’une façon très intuitive.

La classe WP_Widget a été conçue spécialement pour faciliter le développement de widgets. Elle autorise la création de classe étendue, ce qui va vous permettre d’utiliser ses méthodes.

Pour créer la classe de votre propre widget, vous allez vous servir de la classe WP_Widget de cette manière :

class Ma_class extends WP_Widget {} 

Ce dispositif permet de simplifier la création de widget, il faudra donc vous familiariser avec sa mise en œuvre et les méthodes de la classe WP_Widget.

Pour développer un widget, votre classe devra contenir quatre méthodes spécifiques :

Configurer le widget

Pour configurer le widget, il faut instancier l’objet parent de la méthode constructeur __construct(), de cette façon : parent::__construct(). Cela permet de paramétrer le widget et d’indiquer à WordPress qu’il y a un nouveau widget.

public function __construct(){   
    parent::__construct( $id_base , $name, $widget_ops, $control_ops ); 
} 

Voici le détail pour instancier le parent de la méthode __construct() :

parent::__construct( $id_base, $name, $widget_ops, $control_ops ); 

$id_base : nom clé du widget.

$name : nom du widget.

$widget_ops : accepte un tableau contenant un nom de classe HTML et une description.

Exemple

$widget_ops =array( 'classname' => 'your_class', 'description' => 
'your_description' ); 

$control_ops : accepte un tableau additionnel de paramètres (largeur, hauteur, id).

Exemple

$control_ops = array( 'width' =>'your_width', 'height'  
=>'your_height', 'id_base' => 'your_id' ); 

La méthode __construct() a le code suivant :

public function __construct() {  
  $widget_ops = array( 'classname' => 'widget-post',  
                'description' => 'widget...

Enregistrer le widget avec la fonction register_widget()

Avant d’utiliser le widget, enregistrez-le à l’extérieur de la classe, grâce à la fonction WordPress register_widget().

<?php register_widget( $widget_class ); ?> 

$widget_class : le nom de classe du widget concerné.

Il existe une fonction inverse permettant de supprimer l’enregistrement d’un widget :

<?php unregister_widget( $widget_class ); ?> 

Voici les noms de classes des widgets natifs de WordPress :

Afficher le widget grâce à un hook

Pour afficher le widget, greffez le module au core de WordPress à l’aide du hook d’action widgets_init, qui s’exécute lors de l’initialisation des widgets. 

add_action( 'widgets_init', 'register_my_widget' ); 

Désormais, le widget apparaît dans l’administration dans l’onglet Apparence - Widgets et/ou dans les éléments de l’extension Elementor. Si l’onglet Widgets n’est pas présent, cela signifie que le thème ne l’a pas intégré. Il faut soit changer de thème, soit activer cette fonctionnalité avec la fonction register_sidebar($args), si vous comptez utiliser le système de barre latérale.

<?php register_sidebar($args) ?> 

La fonction accepte un argument sous forme d’un tableau contenant des paramètres ; voici les valeurs par défaut :

<?php   
$args = array( 'name' => 'nom de la sidebar',  
             'id' => 'id de la sidebar',  
             'description' => '',  
             'class' => '',  
             'before_widget'...

Créer le formulaire du widget

public function form($instance) { ?>  
<p>  
   <label for="">Titre:</label>  
   <input type="text" id="" name="" value="" style="width:100%;" /> 
</p>  
<p>  
   <label for="">Catégorie: 
   </label>  
   <select id="" name="" value="" style="width:100%;" >  
    <option>toutes les catégories</option>  
<?php  
 foreach((get_categories()) as $cat) {  
    echo '<option value="'.$cat->cat_ID.'">'.$cat->cat_name.'</option>'; 
 }   
?>  
 </select>  
</p>  
<?php   ...

Afficher le widget dans la colonne latérale (sidebar)

Pour afficher le widget sur le site internet, il ne reste plus qu’à alimenter la méthode d’affichage widget().

Dans un premier temps, utilisez la fonction PHP extract() sur le tableau $args pour extraire les clés du tableau sous forme de variables et leur attribuer automatiquement la valeur associée. Rappelons que $args est un tableau contenant des informations sur la barre latérale (sidebar). Les variables sont donc définies directement selon la configuration de la barre latérale. 

Exemple

$args=array('before_title'=>'<h1>','after_title'=>'</h1>');  
extract($args);  
echo $before_title.'mon titre'.$after_title; 

Le titre sera entouré des balises HTML <h1></h1>, les clés du tableau s’utilisent directement en tant que variables, ainsi la clé before_title est utilisable sous la forme $before_title, grâce à la fonction PHP extract().

Voici le code de la méthode widget :

public function widget($args,$instance) {  
 extract($args);  
} 

Dans votre cas, le tableau $args a pour variables...