Керівництво з розробки плагінів для WordPress: покрокове навчання створенню власного плагіна з нуля.

Розуміння основ плагінів та налаштування середовища розробки

Перш ніж почати писати код, дуже важливо ознайомитися з основними концепціями WordPress-плагінів та підготувати відповідне локальне середовище для розробки. Плагін по суті є каталогом, що містить один або кілька PHP-файлів, які дозволяють розширювати або змінювати функціонал WordPress за допомогою системи хуків (Hooks), яка надається цим фреймворком. Відмінною рисою плагінів від тем є те, що вони спрямовані на додавання нових функцій, а не на зміну зовнішнього вигляду веб-сайту; навіть після зміни теми функції плагіна зазвичай залишаються незмінними.

Щоб розпочати розробку, спочатку потрібно створити локальне середовище для роботи з WordPress. Це можна легко зробити за допомогою таких інструментів, як Local by Flywheel, MAMP, XAMPP або безпосередньо за допомогою контейнерів Docker. Після встановлення WordPress на локальному комп’ютері необхідно увійти до системи управління цим середовищем.wp-content/pluginsОсь директорія, де зберігаються всі плагіни. Створіть нову папку, наприклад…my-first-pluginУ цьому папці ви повинні створити основний PHP-файл, який зазвичай носить ту саму назву, що й папка. Наприклад:my-first-plugin.phpЦей головний файл є входною точкою для плагіна; він містить набір спеціальних коментарів-заголовків, які інформують WordPress про назву плагіна, його опис, версію, автора тощо.

Рекомендується увімкнути цю функцію у розробницькому середовищі.WP_DEBUGМодель. Відкрийте каталог кореневого директорію WordPress.wp-config.phpУ файлі знайдіть або додайте наступні рядки:

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

define( ‘WP_DEBUG’, true );
define( ‘WP_DEBUG_LOG’, true );
define( ‘WP_DEBUG_DISPLAY’, false );

Це буде записувати помилки та попередження у…wp-content/debug.logУ файлі наведено інформацію, яка допоможе вам швидко виявляти проблеми під час розробки. Крім того, використання потужного кодового редактора або інтегрованого середовища розробки (IDE), такого як VS Code чи PhpStorm, може значно підвищити ефективність роботи. Ці інструменти зазвичай надають чудову підтримку синтаксису мови PHP та системи WordPress, а також функції підказок під час написання коду.

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

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

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

Створіть свій перший файл плагіна.

Ми пройдемо весь процес від створення файлів до активації плагіна, створивши простий плагін “Hello World”. Цей плагін відображатиме привітальне повідомлення в верхній частині інтерфейсу адміністративної панелі сайту.

У вашому каталозі плагінівmy-first-pluginУ цьому процесі потрібно створити головний файл.my-first-plugin.phpОсновна структура вмісту файлу має починатися з коментарів у верхній частині плагіна:

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://yourwebsite.com/my-first-plugin
 * Description:       这是一个用于学习插件开发的示例插件，它将在后台显示欢迎信息。
 * Version:           1.0.0
 * Author:            开发者姓名
 * Author URI:        https://yourwebsite.com
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 * Domain Path:       /languages
 */

Ці заголовки коментарів є обов’язковими; WordPress використовує їх для ідентифікації та відображення вашого плагіна на сторінці керування плагінами. Серед них…Text DomainВикористовується для інтернаціоналізації (i18n – Internationalization).Domain PathВказано каталог, у якому знаходяться мовні файли (якщо це необхідно).

Далі ми додамо основні функції. У цьому прикладі ми будемо використовувати…admin_noticesХвіст. Додайте наступний код під коментарем у верхній частині коду:

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

// 使用 admin_notices 钩子在管理后台输出提示信息
add_action( ‘admin_notices’, ‘my_first_plugin_display_admin_greeting’ );

/**
 * 在管理后台显示欢迎信息的函数
 * @return void
 */
function my_first_plugin_display_admin_greeting() {
    // 检查当前用户是否有权限，确保只在后台显示
    if ( ! current_user_can( ‘manage_options’ ) ) {
        return;
    }
    ?>
    <div class="notice notice-success is-dismissible">
        <p><?php _e( ‘欢迎使用我的第一个插件！插件开发之旅正式开始！’, ‘my-first-plugin’ ); ?></p>
    </div>
    &lt;?php
}

Після збереження файлу увійдіть у панель керування вашого вебсайту на WordPress та перейдіть на сторінку “Плагіни”. Там ви повинні побачити плагін під назвою “Мій перший плагін” у списку плагінів. Натисніть кнопку “Увімкнути”. Після увімкнення оновіть будь-яку сторінку панелі керування (наприклад, панель приладів) – ви повинні побачити зелене повідомлення про успіх із привітанням, яке було визначено у вашому коді. Це є мінімалізованою, але повноцінною реалізацією функції, яка підтверджує, що ваше середовище розробки та структура плагіна є коректними.

Основні технології WordPress: хаки та фільтри

Розуміння та вміле використання хуків (Hooks) є ключовим елементом розробки плагінів для WordPress. Хуки поділяються на два типи: дії (Actions) та фільтри (Filters). Хуки дій дозволяють вставляти та виконувати власний код у певні моменти часу – наприклад, після публікації статті або перед завантаженням верхньої частини сторінки. Ми використовували саме хуки дій у нашому прикладі.admin_noticesЦе просто функція-хук для виконання певної дії. Фільтр-хуки, навпаки, дозволяють вам змінювати дані, які генеруються під час виконання процесу або передаються іншим модулям – наприклад, змінювати заголовок статті чи результати пош

Як додати власну дію (custom action)?

Дія була успішно виконана.add_action()Додавання функцій. Синтаксис:add_action( ‘hook_name’, ‘your_function_name’, priority, accepted_args )Пріоритет (priority) – це ціле число; чим менше число, тим раніше виконується певна дія. За замовчуванням пріоритет становить 10. Наприклад, якщо ви хочете додати до вмісту статті деякий власний HTML-код:

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

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

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

add_action( ‘the_content’, ‘my_custom_content_append’ );
function my_custom_content_append( $content ) {
    // 只在单篇文章主循环内生效
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $extra_content = ‘<div class="“my-custom-box”"><p>Це користувацький контент, доданий за допомогою плагіна.</p></div>’;
        $content .= $extra_content;
    }
    return $content;
}

Зверніть увагу: хоча…the_contentЦе фільтр (він має повертати модифікований результат).$contentWordPress також використовує це як точку виклику певної дії. Більш точним підходом буде використання…add_filter。

Як додати власний фільтр?

Фільтр пройшов перевірку та готовий до використання.add_filter()Додавання функцій. Синтаксис та…add_action()Подібним прикладом є зміна довжини уривків зі статей.

add_filter( ‘excerpt_length’, ‘my_custom_excerpt_length’, 999 );
function my_custom_excerpt_length( $length ) {
    // 将默认的55个词改为20个词
    return 20;
}

Ви можете створити власні „хаки“ (hooks), щоб ваш плагін також міг бути розширений іншими розробниками чи темами (themes).do_action()Щоб визначити хук дії (action hook), використовуйте відповідні механізми програмування.apply_filters()Опреділімо фільтр-хук (filter hook). Це ключ до створення модульних та розширюваних плагінів.

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

Розширення функціоналу плагінів та найкращі практики їх використання

Коли функції плагінів поступово стають більш складними, гарна організація коду, безпека, здатність до обслуговування та продуктивність набувають вирішального значення. Поширеним підходом є використання об’єктно-орієнтованого програмування (OOP) для створення структури коду, що дозволяє інкапсулювати схожі функції та дан

Використовуйте об’єктно-орієнтоване програмування для інкапсуляції коду.

Створення головної класу дозволить краще керувати станом та методами плагінів, а також уникнути конфліктів у назвах функцій. Ось приклад простої структури об’єктно-орієнтованого програмування:

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

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

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

<?php
/**
 * Plugin Name:       进阶示例插件
 */
if ( ! class_exists( ‘My_Advanced_Plugin’ ) ) {
    class My_Advanced_Plugin {
        /**
         * 构造方法，用于初始化钩子
         */
        public function __construct() {
            add_action( ‘init’, array( $this, ‘register_custom_post_type’ ) );
            add_action( ‘admin_menu’, array( $this, ‘add_admin_menu_page’ ) );
            add_filter( ‘the_title’, array( $this, ‘filter_post_title_prefix’ ), 10, 2 );
        }

/**
         * 注册一个自定义文章类型
         */
        public function register_custom_post_type() {
            $args = array(
                ‘public’ => true,
                ‘label’  => ‘我的产品’,
                ‘supports’ => array( ‘title’, ‘editor’, ‘thumbnail’ ),
                ‘has_archive’ => true,
            );
            register_post_type( ‘my_product’, $args );
        }

/**
         * 在文章标题前添加前缀的过滤器
         * @param string $title 原标题
         * @param int    $id    文章ID
         * @return string 修改后的标题
         */
        public function filter_post_title_prefix( $title, $id = null ) {
            if ( ! is_admin() && in_the_loop() ) {
                $title = ‘[精品] ’ . $title;
            }
            return $title;
        }

// ... 其他方法
    }
    // 实例化插件类
    new My_Advanced_Plugin();
}

Така структура об’єднує схожі функції в єдине ціле, що робить код більш зрозумілим та легким у управлінні.

Забезпечення безпеки та продуктивності плагінів

Безпека є головним пріоритетом під час розробки плагінів. Ніколи не довіряйте даним, введеним користувачем. Для всіх даних, які надходять від користувачів…$_GET、$_POST或$_REQUESTОтримані дані необхідно піддати перевірці (validation), очищенню (sanitization) та обробці для уникнення потенційних проблем під час їх використання (escaping). WordPress надає низку допоміжних функцій для цього.
* 验证：check_ajax_referer()， wp_verify_nonce()
* 清理：sanitize_text_field()， sanitize_email()， absint()
* 转义：esc_html()， esc_url()， wp_kses_post()

Перед виведенням будь-яких даних у HTML, атрибути чи URL обов’язково використовуйте відповідні функції ескапування. Щодо продуктивності, розумно використовуйте спеціальні механізми („хаки“), щоб уникати виконання ресурсоємких запитів при кожному завантаженні сторінки. Розгляньте можливість використання API тимчасового кешування (Transients API) у WordPress для зберігання некритичних, повторюваних результатів запитів протягом певного часу.

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

Більшість плагінів потребують сторінки налаштувань, де користувач може виконати необхідні зміни. Це зазвичай здійснюється за допомогою…add_options_page()或add_menu_page()Функції типу “wait” та інші подібні можна монтувати (прикріплювати) до відповідних елементів системи для забезпечення правильної роботи програми.admin_menuДля реалізації цього потрібно використовувати вбудовані механізми WordPress. Налаштування слід здійснювати за допомогою API Settings, щоб забезпечити безпечну реєстрацію, зберігання та перевірку даних. Це також включає викорregister_setting()、add_settings_section()和add_settings_field()Функції на кшталт цих не лише забезпечують безпеку (наприклад, перевірку значень типу nonce), але й допомагають уніфікувати стиль інтерфейсу веб-сервера WordPress з боку адміністратора.

підсумок

Розробка плагінів для WordPress – це процес перетворення ідей на функціональні рішення, який починається з розуміння основної структури плагіна та налаштування місцевого середовища роботи. Створивши найпростіший плагін “Hello World”, ми практикувалися у всьому процесі від створення файлів до активації їх функцій. Серцем розробки є глибоке розуміння та гнучке використання потужної системи хуків WordPress – дій (actions) та фільтрів (filters), які є мостами для взаємодії з ядром WordPress та іншими компонентами системи. У міру розширення функціоналу плагіна важливими кроками є використання об’єктно-орієнтованого програмування, дотримання стандартів безпечного кодування (перевірка даних, їх очищення, ескапування символів), а також створення сторінок налаштувань за допомогою API Settings. Дотримуючись цих рекомендацій та практик, ви зможете з упевненістю створювати якісні плагіни для WordPress – від простих інструментів до складних додатків.

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

Які передумовні знання потрібні для розробки плагіна для WordPress під назвою ###?
Вам потрібні базові знання мови програмування PHP, оскільки плагіни переважно написані на цій мові. Крім того, базове розуміння HTML, CSS та JavaScript допоможе вам створювати плагіни з фронтенд-інтеракцією. Найважливіше – ви повинні ознайомитися з основними концепціями WordPress: статті, сторінки, категорії, ролі користувачів, а також з системою хуків (hooks).

Як налаштовувати та виправляти помилки у плагіні WordPress, який знаходиться у стадії розробки?

Щиро рекомендуємо увімкнути цю функцію у розробницькому середовищі.WP_DEBUGЩодо параметрів режиму роботи, відповідні налаштування були описані у розділі про налаштування середовища виконання програми. За цим налаштуванням помилки PHP, попередження та сповіщення будуть зберігатися у файлі журналу. Крім того, виerror_log()Функції або допоміжні функції (helper functions)var_dump()Співпрацяwp_die()Використовуйте значення змінних для перевірки. Консоль (Console) та вкладка Мережа (Network) у інструментах розробника браузера є незамінними для налагодження JavaScript-коду та AJAX-запитів.

Як мій плагін може бути сумісним з різними версіями WordPress?

У коді плагіна ви повинні перевіряти, чи існують певні функції чи класи у поточній версії WordPress, перш ніж їх використовувати. Для цього можна скористатися відповідними механізмами та інструментами.function_exists()或is_admin()У поясненні до плагіна це можна зробити за допомогою коментарів у заголовку плагіна.Requires at least:Необхідно вказати мінімальну версію WordPress, яка підтримується вашим плагіном. Регулярне тестування сумісності вашого плагіна з найновішою версією основного коду WordPress є гарною звичкою.

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

Вам потрібно використовувати функції перекладу WordPress для обгортання всіх текстових рядків, які потребують перекладу. Наприклад:__( ‘文本’, ‘your-plugin-text-domain’ )来输出翻译后的文本，使用_e( ‘文本’, ‘your-plugin-text-domain’ )Необхідно правильно налаштувати це у коментарях на початку плагіна.Text Domain和Domain PathПотім використовуйте інструменти на кшталт Poedit для створення потрібних файлів..potШаблонні файли – це документи, на основі яких можуть створюватися інші файли чи вміст..po和.moМовні файли.

Після завершення розробки, як надіслати плагін до офіційного каталогу плагінів?

Спочатку вам потрібно зареєструвати обліковий запис на офіційному сайті WordPress та надіслати свій плагін на перевірку. Ваш код має відповідати офіційним стандартам та рекомендаціям щодо кодування, зокрема щодо безпеки, відсутності шкідливого коду та сумісності з ліцензією GPL. Структура каталогу вашого плагіна має включати основний PHP-файл, а також…readme.txtФайл (у форматі, що відповідає певним стандартам), а також (за бажанням) знімки екрана та іконки. Процес перевірки може зайняти деякий час; команда буде аналізувати ваш код та переконуватися, що він відповідає всім вим