Повний посібник з розробки плагінів для WordPress: створіть свій перший плагін з нуля

Підготовка середовища для розробки плагінів для WordPress

Перш ніж почати писати код, дуже важливо створити стабільне та ефективне локальне середовище розробки. Це не лише дозволяє вам безпечно проводити тести, але й імітує реальну конфігурацію сервера. Для розробки плагінів для WordPress ми настійно рекомендуємо використовувати програмне забезпечення для локальних серверів, таке як XAMPP, MAMP або Local by Flywheel. Вони дозволяють легко налаштувати на вашому комп’ютері середовище, яке включає в себе Apache, PHP та MySQL.

Далі вам знадобиться кодовий редактор. Visual Studio Code, PhpStorm чи Sublime Text – це чудові варіанти, які забезпечують підсвічування синтаксису, підказки під час написання коду та можливості налагодження помилок, що значно підвищує ефективність розробки. Встановіть та налаштуйте ці інструменти, після чого завантажте найновішу версію ядра WordPress та встановіть її на ваш локальний сервер.

Крім того, рекомендується ініціалізувати систему контролю версій (наприклад, Git) у кореневому каталозі вашого проекту з плагінів.git initКоманда дозволяє створити новий репозиторій, що полегшує відстеження змін у коді, відкат помилок та майбутню співпрацю команди. Також рекомендується увімкнути режим налагодження (debugging mode) у WordPress.wp-config.phpУ документі буде...WP_DEBUGСтала величина встановлена якtrueЦе дозволить під час розробки відображати помилки та попередження PHP, що допоможе вам швидко виявити проблеми.

Рекомендуємо до прочитання. Повний посібник з розробки плагінів для WordPress: створіть власний плагін з нуля。

Створення базової структури вашого першого плагіна

Стандартний плагін для WordPress має певну структуру каталогів та файлів. Спочатку потрібно увійти до каталогу, де знаходиться встановлений WordPress.wp-content/pluginsПапка. Створіть тут нову папку для плагіна, який ви збираєтеся розробити. Її назва має бути короткою, унікальною та відображати функції плагіна. Наприклад:my-first-plugin。

UltaHost – хостинг для сайтів, побудованих на платформі WordPress

Гарантія повернення грошей протягом 30 днів, необмежена пропускна здатність мережі та доступ до баз даних, безкоштовний захист від DDoS-атак; знижка 50% при покупці на термін 3 роки (варіанти об’ємів трафіку: 4 ТБ/5

сторінка доступу

Підготовка основного файлу плагіна

У цьому папці створіть файл під назвою….phpФайли з розширенням, які використовуються як основні файли плагінів, зазвичай мають ту саму назву, що й відповідна папка. Наприклад:my-first-plugin.phpЦей файл є входом до плагіна; коментарі з інформацією про плагін, розташовані в його верхній частині, є обов’язковими. Вони надають WordPress метаінформацію про плагін.

<?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
 * Domain Path:       /languages
 */

У цьому коментарі…Plugin NameЦе єдиний обов’язковий етап; інша інформація допоможе користувачам ідентифікувати ваш плагін у системі. Після завершення цього кроку ви фактично створили плагін, який можна активувати. Увійдіть у адміністративну панель WordPress, перейдіть до меню “Плагіни” – там має з’явитися запис “Мій перший плагін”. Хоча наразі він не має жодних функцій, це не є проблемою.

Створення функцій плагінів та інкапсуляція класів

Для забезпечення чіткості та зручності обслуговування коду рекомендується використовувати об’єктно-орієнтований підхід до його організації. У головному файлі або в окремому файлі необхідно визначити клас, який буде об’єднувати всі функ

if ( ! class_exists( 'My_First_Plugin' ) ) {
    class My_First_Plugin {
        public function __construct() {
            // 构造函数，用于初始化动作和过滤器
            add_action( 'init', array( $this, 'init' ) );
        }

public function init() {
            // 插件初始化时执行的操作
            // 例如：注册短代码、自定义文章类型等
        }
    }

// 实例化插件类
    new My_First_Plugin();
}

Ця структура організовує ваші функції у окремому просторі імен (незалежному номенклатурному просторі), що запобігає конфліктам із іменами функцій інших плагінів чи тем.

Рекомендуємо до прочитання. Розробка плагінів для WordPress: створення власних функціональних модулів з нуля。

Реалізація основних функцій: дії та фільтри

Сила плагінів для WordPress полягає у їхній системі хуків (Hooks), яка включає дії (Actions) та фільтри (Filters). Розуміння та ефективне використання цих механізмів є ключовим елементом розробки плагінів.

Використовуйте дії-хаки (action hooks) для додавання нових функцій.

Акційні хаки (action hooks) дозволяють вам вставляти власний код у певні моменти виконання WordPress. Наприклад, якщо ви хочете автоматично додати певний текст після основного контенту статті, ви можете скористатися цими механізмами.the_contentФільтр – це особливий вид “дії”. Більш типовими видами дій є…wp_footerВикористовується для додавання контенту внизу сторінки.

public function __construct() {
    add_action( 'wp_footer', array( $this, 'add_custom_footer_text' ) );
}

public function add_custom_footer_text() {
    echo '<p style="text-align: center;">Дякую за читання! Цей контент був створений моїм першим плагіном.</p>';
}

У цьому прикладі,add_custom_footer_textЦей метод викликається у футері кожної сторінки та виводить певний текст на замовлення.

hosting.com Віртуальний хостинг

Висока продуктивність завдяки процесорам AMD EPYC, SSD-накопичувачам NVMe і технології LiteSpeed, цілодобова експертна підтримка, розширені заходи безпеки, включаючи SSL, грубу силу, захист від шкідливих програм і DDoS, економія до 73%.

сторінка доступу

Використання фільтрів та хуків для модифікації даних

Фільтр-хаки (filter hooks) використовуються для зміни даних перед їх надсиланням у базу даних чи браузер. Поширеним прикладом є зміна заголовків статей. Ми можемо їх використовувати для виконання різних операцій над даними.the_titleФільтри.

public function __construct() {
    add_filter( 'the_title', array( $this, 'customize_title' ) );
}

public function customize_title( $title ) {
    // 只在主循环中且不是后台管理界面时修改
    if ( ! is_admin() && in_the_loop() ) {
        return '📖 ' . $title;
    }
    return $title;
}

Ця функція-фільтр приймає як параметр початкову назву статті та повертає її у зміненому вигляді. Логіка полягає у додаванні символа книги перед назвою статті, яка відображається на передньому екрані.

Інтернаціоналізація плагінів та налаштуванні

Щоб плагін був доступний для користувачів по всьому світу, інтернаціоналізація (i18n) є незамінним кроком. Крім того, надання користувачам можливості налаштувати поведінку плагіна через спеціальну сторінку в менеджері налаштувань значно підвищує його професійний рів

Рекомендуємо до прочитання. Посібник для початківців з розробки плагінів для WordPress: створіть свій перший функціональний плагін з нуля。

Реалізація підтримки перекладу тексту

WordPress використовує технологію GNU gettext для підтримки міжнародної версії програми. Вам потрібно обгорнути всі рядки, які виводяться на передньому чи задньому етапі роботи плагіна користувачеві, певними функціями.

По-перше, у заголовковому файлі плагіна основного файлу ми вже визначили…Text Domain和Domain PathПотім, у функції ініціалізації, завантажується текстове поле.

Міжсерверний віртуальний хостинг

Віртуальний хостинг $2.50 USD на місяць, перший місяць $0.1 USD за промокодом tryinterserver, 461 скрипт хмарних додатків, встановлення в один клік.

сторінка доступу

public function init() {
    load_plugin_textdomain(
        'my-first-plugin',
        false,
        dirname( plugin_basename( __FILE__ ) ) . '/languages/'
    );
}

Потім, у коді, там, де потрібно вивести текст, використовуйте функцію перекладу. Наприклад, у попередньому тексті футера:

echo '<p style="text-align: center;">' . esc_html__( '感谢阅读！本内容由我的第一个插件生成。', 'my-first-plugin' ) . '</p>';

esc_html__()Функція перекладає текст та виконує HTML-еквівалізацію символів, щоб забезпечити його безпеку. Перекладачі можуть використовувати цю функцію для обробки тексту..po和.moФайли необхідні для надання вашому плагіну версій у різних мовах.

Створити сторінку налаштувань для бекенду

Використання API налаштувань WordPress дозволяє створити стандартну та безпечну сторінку налаштувань для вашого плагіна. Цей процес зазвичай включає кілька етапів: реєстрацію налаштувань, додавання зон та полів налаштувань, а також створення відповідної сторінки меню.

public function __construct() {
    add_action( 'admin_menu', array( $this, 'add_admin_menu' ) );
    add_action( 'admin_init', array( $this, 'settings_init' ) );
}

public function add_admin_menu() {
    add_options_page(
        '我的第一个插件设置', // 页面标题
        '我的插件', // 菜单标题
        'manage_options', // 权限
        'my-first-plugin', // 菜单slug
        array( $this, 'settings_page_html' ) // 回调函数，用于输出页面HTML
    );
}

public function settings_init() {
    register_setting( 'my_first_plugin_settings', 'my_first_plugin_options' ); // 注册一组设置

add_settings_section(
        'my_first_plugin_section',
        __( '基本设置', 'my-first-plugin' ),
        null,
        'my-first-plugin'
    );

add_settings_field(
        'footer_text',
        __( '自定义页脚文本', 'my-first-plugin' ),
        array( $this, 'footer_text_field_html' ),
        'my-first-plugin',
        'my_first_plugin_section'
    );
}

public function footer_text_field_html() {
    $options = get_option( 'my_first_plugin_options' );
    ?>
    <input type='text' name='my_first_plugin_options[footer_text]' value='<?php echo esc_attr( $options['footer_text'] ?? '' ); ?>'>
    <?php
}

public function settings_page_html() {
    if ( ! current_user_can( 'manage_options' ) ) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><p><strong>  <p><strong></h1>
        <form action="/uk/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'my_first_plugin_settings' );
            do_settings_sections( 'my-first-plugin' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Зараз користувачі можуть налаштовувати текст футера на сторінці “Налаштування” -> “Мої плагіни”.add_custom_footer_textМетод можна змінити таким чином, щоб він отримував значення з цього варіанта, що зробить плагін конфігурованим.

підсумок

За допомогою цього посібника ми пройшли основний процес розробки плагінів для WordPress: від налаштування локального середовища та створення базової структури файлів до організації коду за допомогою об’єктно-орієнтованих підходів. Ми детально розглянули основні механізми розширення WordPress – дії (actions) та фільтри (filters) – та реалізували практичні функції для додавання контенту у футер та зміни заголовків статей. Нарешті, ми підвищили професіоналізм та зручність використання плагіна, підготувавши його до роботи з користувачами з різних країн за допомогою механізмів інтернаціоналізації, а також створили безпечний інтерфейс налаштувань за допомогою API Settings. Розробка плагінів – це постійний процес навчання та вдосконалення. Опанувавши ці основи, ви зможете досліджувати більш складні аспекти, такі як налаштування власних типів статей, взаємодія з AJAX, інтеграція з REST API тощо, щоб створювати потужні та елегантні плагіни для WordPress.

Часті запитання

Чи обов’язково для розробки плагінів використовувати об’єктно-орієнтоване програмування?

Це не є обов’язковою вимогою, але дуже рекомендується. Використання процесуального програмування (набору функцій) дійсно дозволяє швидко реалізувати потрібні функції, однак зі збільшенням кількості плагінів код стає складнішим у керуванні та обслуговуванні, а також можуть виникати конфлікти назв функцій з іншими плагінами. Об’єктно-орієнтоване програму$thisВикористання змінних та просторів імен (у новіших версіях PHP) допомагає краще організувати код та є найкращою практикою у галузі створення середніх та великих плагінів.

Як безпечно обробляти дані, введені користувачем, або дані з бази даних?

У будь-який момент під час відображення змінних на сторінці необхідно їх ескапувати. WordPress надає низку допоміжних функцій для цього. Залежно від контексту слід використовувати відповідні функції: для відображення всередині HTML-тегів чи атрибутів потрібно використовувати певні спеціальні символesc_html()或esc_attr()；Виведіть значення у змінній JavaScript, використавшиwp_json_encode()或esc_js()Виведіть цей текст у URL-адресі, використовуючи відповідні форматувальні засоби.esc_url()Ніколи не довіряйте даним, введеним користувачем, або непроцесованим даним. Ескапування є ключовим елементом захисту від атак типу XSS (Cross-Site Scripting).

Які умови мають бути виконані, щоб плагін був прийнятий до офіційного каталогу WordPress?

Плагіни, подані до каталогу плагінів WordPress.org, повинні відповідати ряду суворих вимог. Основні з них: код плагіна повинен бути сумісний з ліцензією GPL; не повинен містити ніяких платних стінок, зашифрованого або заплутаного коду; повинен містити повну підтримку інтернаціоналізації; повинен відповідати стандартам кодування та документації WordPress; не повинен здійснювати шкідливі дії, такі як телефонний спам, видобування криптовалюти тощо. Крім того, головний файл вашого плагіна повинен містити стандартну інформацію про плагін, а також потребує надання повного опису.readme.txtДокументи.

Як мені налагодити код свого плагіна?

По-перше, переконайтеся, що цей режим увімкнений у вашому розробничому середовищі.WP_DEBUGДля більш складного налагодження можна використовувати…error_log()Функція записує інформацію до журналу помилок сервера або використовує інші засоби для зберігання даних.var_dump()和wp_die()Перевірте значення змінних (використовуйте цей метод лише у розробницькому середовищі). Більш ефективним способом є використання інструменту Xdebug, який входить до складу інтегрованих середовищ розробки (наприклад, PhpStorm), для крокового налагодження коду. Крім того, у WordPress…WP_DEBUG_LOG和WP_DEBUG_DISPLAYКонстанти дозволяють визначити, чи потрібно записувати помилки у файл журналу чи відображати їх на екрані.