Посібник з розробки плагінів для WordPress: як створити власні функціональні модулі з нуля

Навіщо розробляти власний плагін для WordPress?

Однією з основних філософій дизайну WordPress є його висока розширюваність, а плагіни є основним засобом для реалізації цієї властивості. Хоча офіційна бібліотека плагінів пропонує величезний вибір, розробка власних плагінів дає унікальні переваги. Коли існуючі плагіни не відповідають вашим бізнес-логікам, мають проблеми з продуктивністю або містять зайві функції, індивідуальна розробка є найкращим варіантом. Вона дозволяє створити рішення, яке повністю відповідає потребам проекту, має компактний код та легко піддається обслуговуванню.

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

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

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

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

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

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

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

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

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

<?php
/**
 * Plugin Name:       我的第一个定制插件
 * Plugin URI:        https://www.yourwebsite.com/my-first-plugin
 * Description:       这是一个用于学习WordPress插件开发的入门示例插件。
 * Version:           1.0.0
 * Author:            你的名字
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 */

Цей коментар є ключовим для того, щоб WordPress ідентифікував плагін. Значення поля “Plugin Name” є обов’язковим, решта інформації є необов’язковою. Після створення цього файлу розмістіть його у відповідному місці системи WordPress. /wp-content/plugins/my-first-plugin/ Ви знайдете цей плагін на сторінці “Плагіни” у панелі керування WordPress та зможете його активувати.

Розуміння питань безпеки плагінів та найкращих практик їх використання

Перш ніж починати писати код для будь-яких функцій, необхідно встановити заходи безпеки. WordPress надає велику кількість глобальних змінних та функцій, прямий доступ до основних файлів є небезпечним та забороненим. Тому на початку кожного PHP-файла плагіна слід додати код, який забезпечує захист від прямого доступу до цих файлів.

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

// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
    exit; // 如果ABSPATH未定义，则退出
}

Константа ABSPATH Це абсолютний шлях до кореневого каталогу WordPress, який визначається під час ініціалізації середовища WordPress. Перевіряючи наявність цієї константи, можна ефективно запобігти прямому доступу до файлів вашого плагіна через URL, що допомагає уникнути потенційних ризиків з безпеки. Це перша та найважливіша практика безпеки під час розробки плагінів.

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

Використання хуків для розширення функціоналу WordPress

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

Виконання завдань за допомогою хаків дій (action hooks)

Акційні хаки (action hooks) дозволяють вам виконувати власні функції під час виникнення певних подій. Наприклад, під час публікації статті, при вході користувача або під час завантаження верхньої частини веб-сторінки. Щоб скористатися ак add_action() Функція.

Припустимо, ми хочемо додати власне привітальне повідомлення в верхню частину панелі керування веб-сайтом. Ми можемо це зробити, встановивши відповідний код у відповідні місця коду панелі керування. admin_notices Цей елемент кріпиться за допомогою гачка.

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

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

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

function my_custom_admin_notice() {
    echo '<div class="notice notice-success is-dismissible"><p>Ласкаво просимо до системи керування веб-сайтом! Це сповіщення, додане моїм плагіном.</p></div>';
}
add_action( 'admin_notices', 'my_custom_admin_notice' );

Додайте цей код до вашого основного плагінного файлу. Після активації плагіна щоразу, коли ви увійдете в адміністративну панель, ви побачите це повідомлення. my_custom_admin_notice Це наш власний визначений функція-повернення (callback function).add_action() Поєднайте це з… admin_notices З’єднайте ці хвости (або гачки) між собою.

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

Фільтрувальні хаки (filter hooks) використовуються для модифікації даних перед їх збереженням, відображенням чи використанням. Вони отримують дані, обробляють їх за допомогою вашої функції, а потім мають повернути модифіковані дані. Це досяга add_filter() Функція реалізована за допомогою певних алгоритмів чи програмних модулів.

Класичним прикладом є зміна тексту, що знаходиться в кінці заголовків статей. Наприклад, ми хочемо додати назву веб-сайту після заголовків усіх статей.

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

function modify_post_title( $title ) {
    // 确保只在主循环的单篇文章页面修改
    if ( is_single() && in_the_loop() ) {
        $title .= ' | 我的网站';
    }
    return $title;
}
add_filter( 'the_title', 'modify_post_title' );

Тут,modify_post_title Функція приймає як параметр початковий текст заголовка, додає до нього ім’я веб-сайту та потім повертає цей модифікований текст. WordPress використовує саме це оновлене значення для відображення. Розуміння різниці між діями (actions) та фільтрами (filters) є ключовим для ефективного використання хуків (hooks): дії виконують певні завдання, а фільтри змінюють дані та повертають їх у відповідному вигляді.

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

Багато плагінів потребують взаємодії з адміністратором, що вимагає додавання власних меню керування та сторінок налаштувань. WordPress надає низку функцій для легкого розширення меню адміністративної панелі.

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

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

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

Додати верхній меню керування

Використовуйте add_menu_page() Функція дозволяє додати до бічної панелі керування вашим плагіном головний меню-пункт. Це зазвичай вхідна точка для налаштувань плагіна.

Створімо просту сторінку під назвою “Налаштування мого плагіна”.

function my_plugin_add_menu_page() {
    add_menu_page(
        '我的插件设置',          // 页面标题（浏览器标签）
        '我的插件',              // 菜单标题
        'manage_options',       // 所需权限
        'my-plugin-settings',   // 菜单slug（URL标识）
        'my_plugin_settings_page', // 用于渲染页面内容的回调函数
        'dashicons-admin-generic', // 图标（使用Dashicons）
        30                      // 菜单位置
    );
}
add_action( 'admin_menu', 'my_plugin_add_menu_page' );

Далі вам потрібно визначити керовані функції (callback functions), які були використані вище. my_plugin_settings_page Будь ласка, надайте HTML-код сторінки, який потрібно відобразити.

function my_plugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>Налаштування мого плагіна.</h1>
        <form method="post" action="/uk/options.php/" data-trp-original-action="options.php">
            <?php
            // 输出设置字段（后续可与设置API结合）
            settings_fields( 'my_plugin_options_group' );
            do_settings_sections( 'my-plugin-settings' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Інтеграція з API налаштувань WordPress

Ручне оброблення подань форм та їх перевірки є складним та схильним до помилок процесом. API налаштувань WordPress (Settings API) автоматизує ці процеси, включаючи перевірку значень типу Nonce, перевірку прав доступу та зберігання даних.

Спочатку вам потрібно зареєструвати необхідні налаштування, додати блоки налаштувань та поля.

function my_plugin_settings_init() {
    // 注册一组设置
    register_setting( 'my_plugin_options_group', 'my_plugin_option_name' );

// 添加一个设置区块
    add_settings_section(
        'my_plugin_section_id',
        '主要设置',
        null, // 可选的区块描述回调函数
        'my-plugin-settings'
    );

// 向区块中添加一个字段
    add_settings_field(
        'my_plugin_field_id',
        '示例文本字段',
        'my_plugin_field_callback',
        'my-plugin-settings',
        'my_plugin_section_id'
    );
}
add_action( 'admin_init', 'my_plugin_settings_init' );

// 字段的回调函数，用于输出HTML输入框
function my_plugin_field_callback() {
    $option = get_option( 'my_plugin_option_name' );
    echo '<input type="text" name="my_plugin_option_name" value="' . esc_attr( $option ) . '" />';
}

Тепер на вашій сторінці налаштувань є поле форми, захищене API для налаштувань; значення цього поля буде безпечно збережено у WordPress. options У таблиці бази даних. Через… get_option( 'my_plugin_option_name' ) Це значення можна отримати будь-де – як на фронтенді, так і на бекенді.

підсумок

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

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

Які базові знання необхідні для розробки плагінів для WordPress?

Для розробки плагінів для WordPress необхідні базові знання мови програмування PHP, адже код плагінів здебільшого пишеться на цій мові. Також важливо мати базове розуміння HTML, CSS та JavaScript для створення фронтенд-інтерфейсів та забезпечення їхньої взаємодії з користувачем. Крім того, корисно знати основні концепції WordPress, такі як статті, сторінки, ролі користувачів та механізми обробки даних (наприклад, конструкція The Loop).

Де слід розміщувати функції плагінів та тем?

Це важливе питання щодо найкращих практик розробки веб-сайтів. Весь код, який стосується функціоналу сайту, логіки на серверній стороні та обробки даних, має знаходитися у плагінах. Код, який безпосередньо впливає на візуальне представлення сайту, його макет та стиль (такий як шаблони сторінок, CSS та JavaScript на клієнтській стороні), слід розміщувати у темах (templates). Найбільша перевага такого підходу полягає у тому, що при зміні теми основні функції сайту залишаються незмінними. Наприклад, код для реєстрації користувачів для спеціального типу статей має бути розміщений у плагіні, а файли-шаблони, які відповідають цьому типу статей, – у відповідній т

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

Першим кроком є увімкнення режиму налагодження (debugging mode) у WordPress. У вашому… wp-config.php У файлі буде… WP_DEBUG Стала величина встановлена як trueЦе дозволить безпосередньо відображати PHP-помилки, попередження та сповіщення на сторінці. Крім того, можна використовувати… error_log() Функція записує власну інформацію про налагодження до журналу помилок сервера. Для більш складного налагодження можна використовувати спеціалізовані інструменти PHP-налагодження, такі як Xdebug, або встановлювати плагіни для моніторингу запитів до бази даних (наприклад, Query Monitor), щоб переглядати дані про виконання запитів, функції-хендлери та продуктивність системи.

Як моє додаткове програмне забезпечення (плагін) може підтримувати міжнародну локалізацію?

WordPress використовує фреймворк GNU gettext для реалізації інтернаціоналізації (i18n) та локалізації. У вашому плагіні ви повинні обгорнути всі текстові рядки, які потрібно перекласти, певними функціями. Найпоширенішими з таких функцій є… __() Використовується для перекладу та повернення рядків у коді, а також… _e() Використовується для перекладу та безпосереднього виведення рядків. Також необхідно правильно налаштувати параметри у коментарях до плагіна. Text DomainІ використовуйте це під час завантаження плагіна. load_plugin_textdomain() Функція призначена для завантаження файлів з перекладами. Після цього ви можете використовувати програми на кшталт Poedit для їх обробки та генерації готового продукту (перекладу). .pot Шаблонний файл, а також файли для різних мов. .po 和 .mo Переклад файлу.