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

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

Підготовка розробницького середовища та інструментів

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

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

Оптимальним варіантом є налаштування локального серверного середовища на власному комп’ютері. Для цього можна використовувати такі інструменти, як XAMPP, MAMP (для Mac), WAMP (для Windows) або більш гнучкий підхід з використанням Docker. Ці набори інструментів поєднують в собі сервер Apache, базу даних MySQL та мову програмування PHP, що ідеально імітує умови роботи WordPress у реальному середовищі. Після встановлення локального сервера завантажте останню версію WordPress з офіційного сайту WordPress.org та налаштуйте її відповідно до стандартної процедури встановлення, яка займає приблизно 5 хвилин.

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

Кодові редактори та необхідні інструменти

Потужний кодовий редактор є незамінним інструментом. Visual Studio Code, PhpStorm чи Sublime Text – це чудові варіанти, які забезпечують підкреслення синтаксису, інтелектуальні підказки під час написання коду та можливості налагодження помилок. Крім того, вам знадобиться система контролю версій, наприклад Git, для керування змінами у коді. Хоча перший з додатків може здатися досить простим у використанні, звикнення до роботи з системами контролю версій має вирішальне значення для майбутнього розробництва програмного забезпечення.

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

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

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

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

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

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

У вашому каталозі встановлення WordPress на локальному комп’ютері перейдіть до відповідної папки.wp-content/pluginsПапка. Створіть тут нову папку та назвіть її…my-first-plugin(Назва має бути лаконічною та відображати функції плагіна.) У цьому папку створіть 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
 */

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

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

Додати базові функції до плагіна

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

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

Основною механікою WordPress є система “хуків” (Hooks), яка дозволяє вставляти власний код у певні моменти виконання програми. Акційні хуки (Action Hooks) використовуються для виконання певних дій, а фільтрувальні хуки (Filter Hooks) – для модифікації даних. Щоб додати рядок тексту в кінець статті, нам потрібно скористатися фільтрувальними хуками.the_contentЦей фільтрувальний хук.
Під коментарями на початку вашого основного плагінного файлу додайте наступну функцію та хук:

// 在文章内容末尾添加自定义文本
function myfp_add_footer_text( $content ) {
    // 仅在主循环的单篇文章页面添加
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = '<p><em>Дякуємо, що прочитали! Цей текст був створений за допомогою інструменту “Мій перший плагін” („My First Plugin“).</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
// 将函数挂载到‘the_content’过滤器上
add_filter( 'the_content', 'myfp_add_footer_text' );

Після збереження файлу перезавантажте сторінку статті на фронтенді веб-сайту, і ви побачите доданий текст унизу її вмісту. У цьому фрагменті коду…myfp_add_footer_textФункція приймає оригінальний даний.$contentПісля перевірки умов сторінки до неї був доданий власний текст у вигляді HTML-парagraфа, після чого було повернено оновлене вміст.add_filter()Функція пов’язує нашу власну функцію з основними фільтрами WordPress.

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

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

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

Створення простого меню керування

Наступним кроком є створення сторінки налаштувань для плагіна у веб-сервері WordPress. Для цього необхідно використати дії-хаки (action hooks), щоб додати новий пункт до меню адміністрування. Додайте наступний код:

// 在后台管理菜单中添加一个新页面
function myfp_add_admin_menu() {
    add_menu_page(
        '我的第一个插件设置', // 页面标题
        '我的插件',           // 菜单标题
        'manage_options',     // 所需权限
        'my-first-plugin',    // 菜单slug
        'myfp_admin_page_html', // 用于输出页面内容的回调函数
        'dashicons-admin-generic', // 图标（可选）
        100                   // 菜单位置
    );
}
add_action( 'admin_menu', 'myfp_add_admin_menu' );

// 定义管理页面的HTML内容
function myfp_admin_page_html() {
    // 检查用户权限
    if ( ! current_user_can( 'manage_options' ) ) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><p><strong>  <p><strong></h1>
        <p>Ласкаво просимо на сторінку налаштувань вашого першого плагіна. Це початок!</p>
    </div>
    &lt;?php
}

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

Безпека плагінів та оптимізація коду

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

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

Проверка даних та їх ескапування

Ніколи не довіряйте даним, введеним користувачем, або зовнішнім даним. Перед тим, як виводити будь-які дані у браузер або зберігати їх у базі даних, їх необхідно обробити. WordPress надає безліч допоміжних функцій для цього. Наприклад, під час виведення змінних у властивості HTML слід використовувати відповідні функesc_attr()При виведенні на HTML-текст використовуйте наступну форматування:esc_html()При виведенні на URL слід використовувати спеціальні формати для кращого представлення даних.esc_url()У попередньому…myfp_admin_page_html()У функції ми використали…esc_html()Виведіть заголовок сторінки безпечним способом.

Використовуйте класи для організації коду.

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

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

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

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

class My_First_Plugin {
    // 构造方法，用于初始化钩子
    public function __construct() {
        add_filter( 'the_content', array( $this, 'add_footer_text' ) );
        add_action( 'admin_menu', array( $this, 'add_admin_menu' ) );
    }

public function add_footer_text( $content ) {
        // ... 函数实现同上 ...
    }

public function add_admin_menu() {
        // ... 函数实现同上 ...
    }

public function admin_page_html() {
        // ... 函数实现同上 ...
    }
}
// 实例化插件类
new My_First_Plugin();

Цей підхід об’єднує всі відповідні методи та властивості в одному об’єкті, що робить структуру ще більш зрозумілою.

підсумок

За допомогою цього посібника ви виконали основні кроки створення WordPress-плагіна з нуля: налаштували середовище роботи, створили файл плагіна зі стандартною структурою, використали дії та фільтри для додавання функцій до контенту статей, а також розробили інтерфейс для керування плагіном. Ви також отримали початкове уявлення про важливість безпеки та організації коду. Це лише початок – світ розробки WordPress-плагінів надзвичайно широкий. Ви можете дослідити такі можливості, як короткі коди (Shortcodes), віджети (Widgets), власні типи статей (Custom Post Types), REST API-пункти доступу тощо. Пам’ятайте, що читання основного коду, вивчення практик реалізації якісних плагінів та ознайомлення з офіційною документацією для розробників є найкращими способами для постійного вдосконалення своїх навичок.

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

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

Для розробки плагінів для WordPress необхідно володіти основами PHP, HTML, CSS та JavaScript. PHP є ключовим мовою програмування, оскільки сам WordPress написаний на цій мові; саме нею потрібно писати логіку плагінів. HTML та CSS використовуються для створення користувацького інтерфейсу, а JavaScript (особливо jQuery та сучасні стандарти ES6+) допомагають покращити інтерактивність та виконувати AJAX-запити. Основні знання MySQL також будуть корисними для обробки даних.

Чому мій плагін не відображається у фоновому режимі (у бекенді)?

Будь ласка, спочатку перевірте наступні пункти: 1. Чи розміщено основний файл плагіна уwp-content/pluginsУ окремих папках, що знаходяться у каталозі. 2. Коментарі у верхній частині плагіна основного файлу (особливо…)Plugin Name:1. Формат чи неправильний? 2. Чи є кодування файлу UTF-8 без BOM? 3. Чи є синтаксичні помилки, які призвели до невдалого парсингу PHP? Ви можете перевірити це в журналі відладки WordPress (для цього потрібно його активувати).wp-config.phpУвімкнено.WP_DEBUG）。

Як протестувати плагін, не впливаючи на функціонування онлайн-веб-сайту?

Щиро рекомендуємо розробляти та тестувати плагіни у локальному середовищі розробки (наприклад, Local by Flywheel, XAMPP) або на окремому тестовому сервері (Staging Site). Ні в якому разі не варто тестувати невідпрацьовані нові плагіни безпосередньо на продуктивному сайті, де зберігаються важливі дані. Використовуйте інструменти контролю версій (наприклад, Git) для керування кодом, щоб у разі виникнення проблем можна було легко повернутися до попередньої версії програмного забезпечення.

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

Ви повинні оновити це у коментарях на початку головного файлу плагіна.Version:Поля. Для більших оновлень рекомендується дотримуватися принципів семантичного версіонування (SemVer): для виправлення помилок використовується номер ревізії (наприклад, 1.0.1), для нових функцій, сумісних з попередніми версіями, – номер підверсії (наприклад, 1.1.0), а для несумісних оновлень – номер основної версії (наприклад, 2.0.0). Також можна реалізувати механізми виявлення оновлень (наприклад, розміщувати інформацію про плагіни на власному сервері або в каталозі плагінів WordPress), щоб користувачі отримували сповіщення про оновлення в системі.

Які умови необхідні для публікації плагіна в офіційному каталозі?

Якщо ви хочете надіслати плагін до офіційного каталогу плагінів WordPress.org, вам потрібно виконати наступні основні умови: код плагіна має бути сумісним з ліцензією GPLv2 або вищою; якість коду має відповідати вимогам, встановленим у «Стандартах кодування WordPress»; функції плагіна мають бути універсальними та практичними (тобто придатними для використання на багатьох сайтах, а не призначеними спеціально для одного конкретного сайту); плагін не повинен містити шкідливого коду чи небажаних посилань. Перед надсиланням обов’язково уважно прочитайте детальні інструкції та вимоги у розділі «Центр розробників» офіційного каталогу.