Від нуля до одного: покроково навчимо вас основним навичкам розробки плагінів для WordPress

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

Базова структура та принципи роботи плагінів для WordPress

Перш ніж приступати до написання коду, дуже важливо зрозуміти структуру плагіна та механізм його функціонування в WordPress. Плагін по суті являє собою один або кілька PHP-файлів, які взаємодіють з основною системою WordPress за допомогою API (Application Programming Interface – інтерфейсу програмування додатків).

Основний файл плагіна

Кожен плагін має мати головний файл. Цей головний файл зазвичай називається так само, як і плагін. Наприклад: my-first-plugin.phpНа початку цього файлу має бути присутня певна заголовкова коментаря, присвятована плагіну. WordPress використовує цю інформацію для ідентифікації та відображення плагінів.

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

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

Цей коментар визначає метадані плагіна, такі як його назва, опис, версія тощо, у інтерфейсі адміністрування WordPress. Без цих даних WordPress не зможе розпізнати цей плагін.

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

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

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

Механізм „хуків“: міст між плагінами та основною програмою

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

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

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

Створення розробницького середовища та перший плагін

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

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

Налаштування локального середовища розробки

Рекомендується використовувати інтегровані рішення для локальних серверів, такі як Local by Flywheel, XAMPP або MAMP. Ці інструменти дозволяють одним кліком встановити необхідне середовище PHP, MySQL та веб-сервера для роботи з WordPress. Після встановлення створіть новий веб-сайт під WordPress для розробки плагінів.

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

На вашому локальному веб-сайті, створеному за допомогою системи WordPress… wp-content/plugins У каталозі створіть нову папку, наприклад, my-first-pluginУ цьому папці створіть головний файл. my-first-plugin.phpІ додайте цей код до коментарів на початку відповідного плагіна, про який йшлося вище.

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

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

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

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

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

Сенс існування плагіна полягає у його функціональності. Давайте додамо до плагіна просту, але корисну функцію: автоматичне додавання фрагмента власного тексту наприкінці контенту статті.

Використовуйте фільтри для зміни змісту статті.

Ми будемо використовувати… the_content Цей фільтр-хук. Додайте наступний код у основний файл вашого плагіна:

function myplugin_add_text_to_content( $content ) {
    // 检查是否为单篇文章页面
    if ( is_single() ) {
        $custom_text = '<p><em>Дякую за читання! Цей текст був доданий до мого першого плагіна.</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_add_text_to_content' );

Цей фрагмент коду визначає функцію. myplugin_add_text_to_contentВоно отримує вміст статті. $content Як параметр. Використовується всередині функції. is_single() Використовуйте теги умовного форматування, щоб переконатися, що текст додається лише на сторінці окремої статті. Нарешті, завершіть цей процес… add_filter() Прикріпіть цю функцію (mount the function)… the_content Фільтр вже налаштований. Збережіть файл та оновіть сторінку блогової статті – тоді ви побачите доданий текст.

Рекомендуємо до прочитання. Я покажу вам, як з нуля створити професійний власний сайт на платформі WooCommerce.。

Основні аспекти безпеки плагінів

Безпека є найважливішим аспектом розробки плагінів. Ніколи не слід сліпо довіряти даним, введеним користувачами, чи даним з веб-сайту.
1. Ескапування даних: При виведенні будь-яких даних у браузер необхідно їх ескапувати, щоб запобігти атакам типу XSS (Cross-Site Scripting). WordPress надає для цього відповідні інструменти та механізми. esc_html(), esc_attr(), esc_url() Додаткові допоміжні функції.
2. Перевірка та очищення введених даних: Дані, отримані з форм користувачів або URL-параметрів, повинні піддаватися перевірці (перевірці правильності формату) та очищенню (видаленню недійсних символів) перед їх використанням. Для цього можна використовувати відповідні функції sanitize_text_field()。
3. Безпека від несанкціонованих змін даних: Якщо ваш плагін передбачає зміну даних (наприклад, збереження налаштувань), необхідно використовувати механізм несанкціонованих значень (Nonce) від WordPress для перевірки мети запиту, щоб запобігти атакам типу CSRF (Cross-Site Request Forgery).

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

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

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

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

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

Створення меню керування та відповідних сторінок

Ми можемо використати цей інструмент/метод. add_menu_page() 或 add_options_page() Функція для додавання елемента меню до бекенду WordPress. Наведений нижче код додає сторінку з параметрами, яка розташована під підменю “Налаштування”:

function myplugin_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',        // 所需权限
        'myplugin-settings',     // 菜单Slug
        'myplugin_render_settings_page' // 用于渲染页面的回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

Далі нам потрібно визначити функцію-повернення (callback function). myplugin_render_settings_page Створити HTML-контент для сторінки налаштувань і обробити логіку збереження форми. На сторінці слід використовувати API налаштувань WordPress для безпечної обробки параметрів, але в якості вступного прикладу тут наведено спрощений варіант:

function myplugin_render_settings_page() {
    ?>
    <div class="wrap">
        <h2>Налаштування мого плагіна.</h2>
        <form action="/uk/options.php/" method="post" data-trp-original-action="options.php">
            <?php settings_fields( 'myplugin_settings_group' ); ?>
            <label for="custom_text">Користувацький текст:</label><br/>
            <textarea id="custom_text" name="myplugin_custom_text" rows="4" cols="50"><?php echo esc_textarea( get_option( 'myplugin_custom_text' ) ); ?></textarea>
            <p class="submit">
                <input type="submit" name="submit" class="button-primary" value="Зберегти зміни" />
            </p>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Зареєструйтеся, налаштуйте параметри та обробіть дані.

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

function myplugin_register_settings() {
    register_setting(
        'myplugin_settings_group', // 设置分组
        'myplugin_custom_text',    // 选项名称
        'sanitize_textarea_field'  // 清理回调函数
    );
}
add_action( 'admin_init', 'myplugin_register_settings' );

Наостанок, змініть функцію для додавання контенту статей, яка раніше використовувала параметри з бази даних. myplugin_custom_text Зчитувати текст, збережений користувачем, з відповідних джерел, а не використовувати жорстко закодований текст.

підсумок

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

Після оволодіння цими ключовими навичками ви отримаєте основу для подальшого дослідження розробки більш складних плагінів для WordPress. Далі ви зможете вивчати такі складніші теми, як налаштування власних типів статей, метадані (Meta Box), короткі коди (Shortcodes), REST API-пункти доступу та використання Ajax-запитів, щоб створювати плагіни з більш розширеними функціями та високою ефективністю.

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

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

Вам потрібні базові знання мови програмування PHP, адже ядро WordPress та його плагіни написані на цій мові. Також буде дуже корисно знати HTML, CSS та основи JavaScript, особливо під час створення користувацького інтерфейсу. Знайомство з основними концепціями баз даних MySQL також є перевагою.

Як налаштувати (діагностувати та виправити) код мого плагіна?

Найпоширенішим методом налагодження під час розробки в WordPress є увімкнення функції дебагування. WP_DEBUGВи можете це зробити на веб-сайті. wp-config.php У файлі буде… define(‘WP_DEBUG’， true); Змініть значення цього рядка на… trueЦе виведе всі PHP-помилки, попередження та сповіщення на екран та збереже їх у файлі журналу. Крім того, використовується… error_log() Функція, яка виводить інформацію про змінні у журнал помилок сервера, є також дуже корисним прийомом для налагодження (дебагування) програми.

Як мій плагін має підтримувати багатомовність?

Щоб зробити ваш плагін інтернаціоналізованим, вам потрібно використовувати функції перекладу WordPress (наприклад, __()， _e()Використовуйте спеціальні теги для обгортання всіх рядків, призначених для користувача. Потім скористайтеся інструментами на кшталт Poedit для їх генерації. .pot Це шаблонний файл, за допомогою якого перекладачі можуть створювати тексти різних мов. .po 和 .mo Файл. Нарешті, використовуйте його у головному файлі плагіна. load_plugin_textdomain() Функція для завантаження файлів з перекладами.

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

Спочатку переконайтеся, що ваш плагін повністю відповідає офіційним стандартам кодування WordPress та вимогам ліцензії GPL. Потім зареєструйте SVN-репозиторій для вашого плагіна на сайті WordPress.org. Вам знадобиться використовувати інструменти SVN для завантаження та зберігання коду вашого плагіна у цьому репозиторії. /trunk Зміст. Водночас підготуйте високоякісний продукт. readme.txt Знімки екрана файлів, плагінів та їх іконок. Після подання заявки офіційна команда рецензентів перевірить ваш плагін, і після схвалення він зможе бути опублікований у офіційному каталозі.