Débuter de zéro : Maîtriser les étapes clés et les meilleures pratiques du développement de plugins pour WordPress

Débuter de zéro : Maîtriser les étapes clés et les meilleures pratiques du développement de plugins pour WordPress

Le développement de plugins pour WordPress est une excellente façon d’élargir les fonctionnalités d’un site web. En créant des plugins personnalisés, les développeurs peuvent ajouter des fonctionnalités uniques au site sans avoir à modifier le code de base de WordPress. Cela non seulement améliore la flexibilité du site, mais assure également que ces fonctionnalités personnalisées fonctionnent de manière sûre et stable lors des mises à jour du noyau de WordPress. Un plugin WordPress bien structuré respecte une organisation des fichiers spécifique, des normes de codage établies, ainsi que l’API de WordPress.

Cet article vous guidera dans le processus complet allant de la création de votre premier fichier de plugin à sa publication sécurisée, en couvrant les concepts fondamentaux, les outils essentiels et les meilleures pratiques à connaître au cours du développement.

Lectures recommandées Guide complet pour le développement de plugins WordPress : Construire des fonctionnalités d'extension de haute qualité pour WordPress, de zéro à un。

Environnement de développement et structure de base

Avant d’écrire le moindre code, il est essentiel de mettre en place un environnement de développement approprié. Il est recommandé d’utiliser des outils de développement locaux tels que Local by Flywheel, XAMPP ou MAMP, qui permettent de configurer rapidement un environnement comprenant PHP, MySQL et un serveur web. De même, un éditeur de code (comme VS Code ou PhpStorm) ainsi que des outils de débogage (comme Query Monitor ou Debug Bar) sont indispensables.

Hébergement WordPress par UltraHost

Garantie de remboursement dans les 30 jours, bande passante illimitée et base de données, protection gratuite contre les attaques DDoS. Avantage de 501 TP4T pour les achats sur 3 ans.

page d'accès

Créez votre premier fichier de plugin.

La forme la plus basique d’un plugin pour WordPress est un fichier qui se trouve dans le répertoire des plugins du site web. /wp-content/plugins/ Les fichiers PHP situés dans le répertoire correspondant doivent contenir, en tête de leur fichier principal, des commentaires contenant les informations standard relatives au plugin. C’est la base permettant à WordPress de reconnaître et de gérer ces plugins.

Créez quelque chose qui s’appelle… my-first-plugin.php Faites appel au fichier approprié et saisissez le contenu suivant :

<?php
/**
 * Plugin Name: 我的第一个插件
 * Plugin URI:  https://example.com/my-first-plugin
 * Description: 这是一个用于演示的简单 WordPress 插件。
 * Version:     1.0.0
 * Author:      你的名字
 * Author URI:  https://example.com
 * License:     GPL v2 or later
 * Text Domain: my-first-plugin
 */

Enregistrez ce fichier dans : /wp-content/plugins/my-first-plugin/ Dans le dossier correspondant, puis après avoir connecté à l’administration de WordPress via la page “ Plugins ”, vous pourrez voir et activer ce plugin. Bien qu’il n’ait aucune fonction pour l’instant, sa structure est déjà complète.

Répertoire des plugins et organisation des fichiers

Avec l'augmentation du nombre de fonctionnalités, un seul fichier devient difficile à maintenir. Un répertoire de plugins bien structuré comprend généralement les éléments suivants :
* 主插件文件：plugin-name.php
* includes/ Contenu : stocker les fichiers des classes ou fonctions principales.
* admin/ Répertoire : Contient le code, le CSS et le JavaScript liés au backend.
* public/ Répertoire : Contient le code, le CSS et le JavaScript liés à l’interface utilisateur (front-end).
* assets/ Répertoire : Il contient des images, des fichiers de style (stylesheets) et des fichiers de scripts.
* languages/ Répertoire : Contient les fichiers de traduction internationaux (.pot, .po, .mo).
* uninstall.php Fichier : Options utilisées pour nettoyer la base de données lorsque des plugins sont supprimés.

Lectures recommandées Guide complet pour le développement de plugins WordPress : de l’introduction à la mise en pratique pratique。

Concepts et technologies clés du développement

Le cœur du développement de plugins pour WordPress réside dans la compréhension et l’utilisation maîtrisée de son API (Application Programming Interface), qui comprend principalement les crochets d’action (Action Hooks), les crochets de filtre (Filter Hooks) et les codes courts (Shortcodes).

Maîtriser l'utilisation des hooks d'action

Les “ action hooks ” vous permettent d’insérer votre propre code à des moments précis pendant l’exécution de WordPress. add_action() Une fonction peut permettre d’associer votre fonction personnalisée à un « crochet » (hook).

Par exemple, le code suivant ajoute une ligne de meta-tag personnalisé en haut de toutes les pages :

hosting.com Hébergement partagé

Hautes performances avec les CPU AMD EPYC, stockage SSD NVMe et LiteSpeed, support interne expert 24h/24 et 7j/7, mesures de sécurité avancées, notamment SSL, protection contre la force brute, les logiciels malveillants et le DDoS, économies pouvant aller jusqu'à 73%.

page d'accès

function myplugin_add_custom_meta() {
    echo '<meta name="my-custom-meta" content="value">';
}
add_action( 'wp_head', 'myplugin_add_custom_meta' );

Un autre exemple courant est l’exécution d’opérations d’initialisation lorsque un plugin est activé, comme la création de tables dans une base de données. Cela nécessite d’associer (de « monter ») la fonction concernée à des événements appropriés du plugin. register_activation_hook Sur le crochet.

Modifier le contenu à l’aide de filtres.

Les hooks de filtre permettent de modifier les données que WordPress traite au cours de son processus. Vous pouvez les utiliser pour effectuer des modifications appropriées. add_filter() Des fonctions sont utilisées pour modifier le contenu des textes, les valeurs des options, etc. Les fonctions de filtrage doivent retourner une valeur.

L'exemple suivant ajoute automatiquement un texte personnalisé à la fin du contenu de l'article.

Lectures recommandées Guide complet pour le développement de plugins WordPress : Construire votre premier plugin fonctionnel de zéro。

function myplugin_modify_post_content( $content ) {
    if ( is_single() ) {
        $custom_text = '<p><em>Merci de lire cet article !</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_modify_post_content' );

Créer et gérer des codes courts

Les codes courts permettent aux utilisateurs d’insérer facilement du contenu dynamique généré par des plugins dans des articles, des pages ou des outils. add_shortcode() Une fonction peut permettre d’enregistrer un nouveau raccourci (ou code abrégé).

S’inscrire sous le nom de… [greeting] C’est un code abrégé qui peut afficher différents salutations en fonction de l’heure :

Hébergement partagé InterServer

Hébergement mutualisé $2.50 USD par mois, premier mois $0.1 USD code promo tryinterserver, 461 scripts cloud apps, installation en un clic.

page d'accès

function myplugin_greeting_shortcode( $atts ) {
    $hour = date( 'G' );
    $greeting = ( $hour ? 'Bonjour !' : ( ($hour) < 18 ) ? '下午好！' : '晚上好！' );
    return &#039;<div class="greeting">' . esc_html( $greeting ) . '</div>'php
add_shortcode('greeting', 'myplugin_greeting_shortcode');

Sécurité des plugins et gestion des données

Développer un plugin sécurisé est la première étape pour protéger un site web et les données des utilisateurs. Cela implique la validation des données saisies, l’échappement des données affichées, le contrôle des autorisations, ainsi que le traitement sécurisé des données.

Implementer la validation des données et l’échappement des caractères spéciaux.

Ne faites jamais confiance aux données saisies par les utilisateurs. Avant de sauvegarder ces données dans une base de données ou de les afficher dans un navigateur, il est indispensable de les vérifier et de les échapper (c’est-à-dire de modifier certaines caractéristiques pour éviter des problèmes de sécurité).

• Vérification : Utiliser sanitize_text_field(), sanitize_email(), intval() Des fonctions telles que celles-ci sont utilisées pour nettoyer les données saisies par l'utilisateur.
• Échappement : Lors de l’affichage de données dans HTML, JavaScript ou des URL, utilisez les fonctions d’échappement appropriées. esc_html(), esc_js(), esc_url()。

Par exemple, traiter de manière sûre et afficher le nom d'utilisateur soumis via un formulaire :

$user_input = $_POST['username'] ?? ''; // 使用空合并运算符提供默认值
$clean_username = sanitize_text_field( $user_input );
echo '你好，' . esc_html( $clean_username );

Utiliser l’API des options de WordPress

Pour les paramètres simples qui doivent être stockés (comme des boutons de contrôle, du texte, etc.), il conviendra d’utiliser l’API des options de WordPress. Celle-ci offre une interface pratique pour gérer ces paramètres. add_option(), get_option(), update_option() et delete_option() Des fonctions telles que celles-ci permettent de stocker des données de manière sûre. wp_options Dans le tableau.

Créez une configuration pour un plugin et récupérez-la.

// 保存一个选项
update_option( 'myplugin_setting_color', '#336699' );

// 获取一个选项，如果不存在则使用默认值
$color = get_option( 'myplugin_setting_color', '#000000' );

Créer une table de base de données personnalisée.

Lorsqu’un plugin a besoin de stocker des données relationnelles complexes, il peut être nécessaire de créer des tables de base de données personnalisées. Cela doit généralement être effectué lors de l’activation du plugin et respecter les conventions du schéma de base de données de WordPress.

Dans my-first-plugin.php Dans ce code, une fonction pour créer une table est ajoutée au crochet d’activation du plugin.

function myplugin_create_custom_table() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'myplugin_items'; // 使用 $wpdb->prefix 确保表前缀正确
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE IF NOT EXISTS $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        name varchar(100) NOT NULL,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}
register_activation_hook( __FILE__, 'myplugin_create_custom_table' );

Concevoir l'interface d'administration back-end du plug-in.

Créer une page de configuration en arrière-plan intuitive pour votre plugin est essentiel pour offrir une bonne expérience utilisateur. WordPress propose de nombreuses API pour simplifier la création de menus de gestion, de pages de configuration et de formulaires.

Ajouter un menu de gestion ainsi que des sous-menus.

utiliser add_menu_page() et add_submenu_page() Les fonctions permettent d’ajouter des éléments de menu à la barre latérale du panneau d’administration de WordPress pour votre plugin.

Voici le code modifié pour ajouter un menu principal intitulé “ Mes plugins ” et un sous-menu intitulé “ Paramètres ” :

function myplugin_add_admin_menu() {
    // 添加顶级菜单
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 所需权限
        'myplugin-dashboard',   // 菜单 Slug
        'myplugin_dashboard_page', // 回调函数，用于输出页面内容
        'dashicons-admin-generic', // 图标
        30                      // 菜单位置
    );

    // 添加子菜单
    add_submenu_page(
        'myplugin-dashboard',   // 父菜单 Slug
        '插件设置',             // 页面标题
        '设置',                 // 菜单标题
        'manage_options',       // 权限
        'myplugin-settings',    // 子菜单 Slug
        'myplugin_settings_page' // 回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

// 定义“仪表盘”页面的回调函数
function myplugin_dashboard_page() {
    echo '<div class="wrap"><h1>Mon tableau de bord de plugins</h1></div>';
}

// 定义“设置”页面的回调函数
function myplugin_settings_page() {
    echo '<div class="wrap"><h1>Les paramètres de mon plugin</h1></div>';
}

API d’configuration intégrée pour la création de formulaires

L’API de configuration de WordPress offre une méthode sûre et standardisée pour créer, valider et enregistrer les paramètres des formulaires. Cela implique l’enregistrement des paramètres, l’ajout de zones de configuration et de champs.

Voici un exemple simple pour créer une page de configuration contenant un champ de texte :

function myplugin_settings_init() {
    // 注册一个新的设置项 “myplugin_settings”
    register_setting( 'myplugin_settings_group', 'myplugin_settings' );

    // 添加一个新的设置区域
    add_settings_section(
        'myplugin_section_basic',
        '基础设置',
        null, // 区域描述的回调函数，这里不需要
        'myplugin-settings' // 页面 Slug
    );

    // 在区域内添加一个字段
    add_settings_field(
        'myplugin_field_api_key',
        'API 密钥',
        'myplugin_field_api_key_callback', // 渲染字段 HTML 的回调函数
        'myplugin-settings',
        'myplugin_section_basic'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

// 字段的回调函数
function myplugin_field_api_key_callback() {
    $options = get_option( 'myplugin_settings' );
    $value = $options['api_key'] ?? '';
    echo '<input type="text" name="myplugin_settings[api_key]" value="' . esc_attr( $value ) . '" class="regular-text">';
}

// 修改之前的设置页面回调函数，以输出表单
function myplugin_settings_page() {
    ?&gt;
    <div class="wrap">
        <h1>Les paramètres de mon plugin</h1>
        <form action="/fr/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'myplugin_settings_group' ); // 输出必要的安全字段
            do_settings_sections( 'myplugin-settings' ); // 输出所有设置区域和字段
            submit_button(); // 输出提交按钮
            ?>
        <input type="hidden" name="trp-form-language" value="fr"/></form>
    </div>
    &lt;?php
}

résumés

Le développement de plugins pour WordPress commence par la compréhension de sa structure de base, puis se poursuit en explorant en profondeur les API et les mécanismes de sécurité, jusqu’à la création d’une interface utilisateur complète. L’essentiel est de respecter les normes de codage et les bonnes pratiques de WordPress, telles que l’utilisation correcte des hooks, une gestion rigoureuse de la sécurité des données, ainsi que l’exploitation des API d’options et de configuration intégrées au système. Il faut commencer par créer un fichier de commentaires contenant les informations de base du plugin, puis ajouter progressivement des actions, des filtres et des codes courts, avant de gérer la base de données et l’interface d’administration. Chaque étape repose sur le cadre solide et fiable de WordPress. En apprenant et en pratiquant systématiquement ces étapes, vous serez en mesure de développer des plugins fonctionnels, sûrs, fiables et faciles à maintenir, contribuant ainsi à l’immense écosystème WordPress à l’échelle mondiale.

FAQ Foire aux questions

Pour développer un plugin WordPress, quelles connaissances de base sont nécessaires ?

Pour développer des plugins pour WordPress, il est nécessaire de maîtriser le langage de programmation PHP, car le code central des plugins est écrit en PHP. Il est également essentiel de connaître les bases d’HTML, CSS et JavaScript pour construire les interfaces utilisateur et les interactions. Le plus important est de bien comprendre les concepts fondamentaux de WordPress, tels que les « hooks » (Actions et Filters), les boucles (The Loop), la hiérarchie des templates, ainsi que la structure de la base de données de WordPress.

Comment déboguer mon plug-in WordPress ?

Tout d’abord, wp-config.php Activer le mode de débogage de WordPress dans le fichier… WP_DEBUG La constante est définie à trueCela affichera les erreurs et les avertissements PHP à l’écran. De plus, il est possible d’utiliser… error_log() La fonction écrit les informations de débogage dans le journal d'erreurs du serveur. De plus, l'installation d'extensions de débogage professionnelles, telles que Query Monitor, permet de consulter en temps réel des détails sur les requêtes de base de données, l'exécution des hooks, le chargement des scripts, etc. Celles-ci constituent des outils indispensables au cours du processus de développement.

Comment mon plugin peut-il prendre en charge plusieurs langues (internationalisation) ?

WordPress utilise le framework technologique GNU gettext pour mettre en œuvre l’internationalisation (i18n). Tout d’abord, dans le code des plugins, toutes les chaînes de caractères qui doivent être traduites sont identifiées et traitées de manière appropriée. () Ou _e() Encapsulez les fonctions de traduction et fournissez des… () La fonction spécifie le domaine de texte (Text Domain) à définir en tête du plugin. Ensuite, des outils tels que Poedit sont utilisés pour analyser le code source du plugin et générer les éléments nécessaires. .pot Des fichiers de modèle, sur lesquels des versions en différentes langues sont créées. .po Et après compilation. .mo Faites des copies de ce fichier et placez-les dans les dossiers correspondants des plugins. /languages/ Dans le répertoire. Enfin, utilisez… load_plugin_textdomain() Translation of “Function loading”.

Comment soumettre mon plugin au répertoire officiel de plugins de WordPress ?

Avant de soumettre votre plugin au répertoire officiel, assurez-vous qu’il respecte pleinement les spécifications et les guides de développement de plugins officiels. Vous devez disposer d’un compte WordPress.org, puis remplir le formulaire sur la page de soumission de plugins. L’équipe d’audit vérifiera la sécurité de votre code, la licence (elle doit être compatible avec GPL), la qualité du code, les documents fournis ainsi que la compatibilité de votre plugin avec d’autres plugins et fonctionnalités de WordPress. Une fois l’audit réussi, vous recevrez l’adresse d’un répertoire SVN. En soumettant votre code via SVN, votre plugin sera ajouté au répertoire officiel. Ce processus peut prendre plusieurs semaines et est soumis à des critères d’audit détaillés.