Comment créer votre premier plugin ExpressionEngine: analyse d'étape détaillée

Préface

ExpressionEngine (EE pour Short) est un puissant système de gestion de contenu dont la flexibilité et l'évolutivité en font le premier choix pour de nombreux développeurs de sites Web. EE a non seulement une variété de modules et de balises intégrés, mais prend également en charge les plug-ins de développement des utilisateurs pour développer davantage les fonctions système. Cet article vous présentera la façon de créer votre premier plug-in ExpressionNingin, vous aidant à utiliser pleinement le mécanisme du plug-in d'EE et à améliorer l'efficacité de développement du site Web.

Qu'est-ce qu'un plugin?

Dans EE, les plug-ins sont un moyen d'étendre les fonctionnalités du système. Il peut gérer une logique complexe, intégrer des services externes et d'autres fonctions. Le plug-in peut être utilisé dans les modèles, les panneaux de commande, les pages statiques, etc., il suffit de l'appeler via des balises simples.

Classification des plugins

Les plugins dans ExpressionNengine peuvent être divisés en catégories suivantes:

• Plugins standard : utilisé pour gérer la logique de traitement de base.
• Plugins d'extension : étendez les fonctions principales de l'EE, telles que l'ajout de nouveaux widgets, la réécriture de l'URL de gestion, etc.
• Plugins du module : plugins utilisés dans le panneau de configuration de l'arrière-plan EE.
• Plugins de modèle : utilisé dans les plugins dans des modèles de page, tels que la sortie du contenu dynamique.

Créer un plug-in

Après avoir compris la classification de base des plug-ins, nous présenterons comment créer un plug-in standard.

Étape 1: Créez un répertoire de plugin

Tout d'abord, créez un nouveau dossier dans le répertoire du plug-in EE pour stocker le plug-in que nous sommes sur le point de créer. En règle générale, le répertoire du plugin d'EE est situé dans / System / ExpressionEngine / Third_Party /, qui peut être configuré dans les paramètres du système.

Étape 2: Créez un fichier plug-in

Dans le répertoire de plugin nouvellement créé, créez un fichier de plugin et le nom de fichier doit être le même que le nom du plugin. Le fichier de plugin doit contenir une classe EE_PLUGIN, qui est responsable de la gestion de la logique spécifique du plugin. L'exemple de code est le suivant:

 
class My_plugin {
    // Logique du plugin
}

Étape 3: configurer les informations plug-in

Dans le fichier de plug-in, nous devons configurer certaines informations de base, telles que le nom de plug-in, le numéro de version, qu'il prenne en charge le cache, etc. Vous pouvez utiliser PHPDOC pour le configurer, l'exemple de code est le suivant:

 
/**
 * Plugin Name
 *
 * @package   My_plugin
 * @version   1.0.0
 * @author    Your Name
 * @link      [Lien de votre site Web]
 */
class My_plugin {
    // Logique du plugin
}

Étape 4: Enregistrez le plugin

Après avoir terminé les informations de configuration, vous devez enregistrer le plug-in avec EE afin que le système puisse reconnaître et charger le plug-in. L'enregistrement du plugin est effectué via le code suivant:

 
ee()->plugins->register('My_plugin', 'My_plugin');

Où, le premier paramètre est le nom du plugin et le deuxième paramètre est le nom de classe créé à l'étape 2.

Instance de plugin

Ensuite, nous créerons un exemple de plugin pour ajouter des balises personnalisées au modèle.

Étape 1: Créez un répertoire de plugin

Tout d'abord, vous devez créer un répertoire de plugin, par exemple: / System / ExpressionEngine / Third_Party / My_Plugin /.

Étape 2: Créez un fichier plug-in

Créez un fichier nommé my_plugin.php dans ce répertoire, avec le contenu suivant:

 
/**
 * My Plugin
 *
 * @package   My_plugin
 * @version   1.0.0
 * @author    Your Name
 * @link      [Lien de votre site Web]
 */
class My_plugin {
    
    public $return_data = ''; // Initialiser la valeur de retour
    
    /**
     * Tags personnalisés
     *
     * @access  public
     * @return  string
     */
    public function custom_tag()
    {
        $output = 'Hello World!';
        return $output;
    }
}

Dans ce fichier, nous définissons une classe nommée my_plugin et créons une méthode nommée personnalisée_tag () qui renvoie la chaîne "Hello World!".

Étape 3: enregistrez le plugin

Après avoir terminé le code du plug-in, nous enregistrons le plug-in vers EE, le code est le suivant:

 
ee()->plugins->register('My_plugin', 'My_plugin');

Étape 4: Utilisez des balises personnalisées

Dans le modèle, vous pouvez utiliser la balise personnalisée que vous venez de créer, l'exemple de code est le suivant:

 
{exp:My_plugin:custom_tag}

Dans cet exemple, nous appelons la méthode Custom_tag () dans le plugin my_plugin et le modèle affichera "Hello World!".

Résumer

Le plug-in est l'un des puissants mécanismes d'extension de l'EE. Il peut étendre les fonctions de l'EE via des plug-ins, gérer diverses logiques commerciales complexes et rendre le site Web plus flexible et puissant. Cet article décrit comment créer un plugin EE simple, j'espère qu'il vous sera utile.