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

Чому варто розробляти власні плагіни для WordPress?

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

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

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

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

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

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

Усі плагіни для WordPress мають мати основний PHP-файл, який містить певні коментарі (хедери плагіна). Це ключове для того, щоб WordPress міг розпізнати цей плагін. Вам потрібно…wp-content/pluginsСтворіть нову папку в каталозі, наприклад,my-first-pluginПотім створіть головний файл у цьому папці.my-first-plugin.php。

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

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

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

Коментарі на початку файлу мають містити інформацію про назву плагіна, опис, версію, автора тощо. Ось найпростіший приклад:

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

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

Організація каталогу плагінів та файлів

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

my-first-plugin/
├── my-first-plugin.php      // 主文件，包含插件头和管理核心钩子
├── includes/                // 存放核心功能类或函数文件
│   └── class-core-functions.php
├── admin/                   // 后台相关的CSS、JS和PHP文件
│   ├── css/
│   ├── js/
│   └── admin-settings.php
├── public/                  // 前端相关的CSS、JS和PHP文件
│   ├── css/
│   ├── js/
│   └── class-public-handler.php
└── languages/               // 国际化翻译文件（.po/.mo）

У головному файліmy-first-plugin.phpУ цьому випадку ви можете використовувати…require_once或include_onceЦі модульні файли можна імпортувати за потреби. Така структура чітко розділяє логіку серверної частини, відображення на передньому екрані та основні функції програми.

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

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

Архітектура плагінів WordPress ґрунтується на системі зв’язків (hooks), яка працює на основі подій (events). Основні компоненти цієї архітектури включають:Action(Дія) іFilter(Фільтри). Розуміння та використання фільтрів є основою розробки плагінів.

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

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

Наприклад, якщо ви хочете додати повідомлення для адміністратора вгорі меню адміністративної панелі сайту, ви можете скористатися відповідними інструментами чи функціями, які надаються системою управління сайтом.admin_noticesЦей „хак“ для виконання певної дії. Спочатку необхідно визначити функцію у основному файлі плагіна.my_custom_admin_noticeПотім прикріпіть його до крюка.

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>';
}
// 将函数挂载到 admin_notices 动作钩子
add_action( 'admin_notices', 'my_custom_admin_notice' );

Коли WordPress виконує…admin_noticesУ цей момент буде автоматично викликана функція, яку ви прикріпили, що призведе до виведення сповіщення. Акційний хук (action hook) призначений для виконання певної дії та не вимагає повернення значення.

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

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

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

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

// 定义修改内容的函数
function append_custom_text_to_content( $content ) {
    if ( is_single() ) { // 仅对单篇文章页面生效
        $custom_text = '<p><em>Дякуємо за читання! Ця стаття була створена за підтримки мого плагіна.</em></p>';
        $content .= $custom_text;
    }
    return $content; // 必须返回修改后的内容
}
// 将函数挂载到 the_content 过滤器钩子
add_filter( 'the_content', 'append_custom_text_to_content' );

Функція-фільтр приймає одне вхідне значення (тут…)$contentПісля обробки має бути повернено певне значення. За допомогою цього методу ви можете гнучко змінювати майже будь-які дані, які обробляє WordPress.

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

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

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

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

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

Додати верхній меню або підменю

Ви можете використовувати ці можливості.add_menu_page()Функція створює для плагіна окремий верхній меню в бекенді, або ж використовує вже наявні механізми меню.add_submenu_page()Розгляньте цей елемент як підменю до існуючого меню (наприклад, “Налаштування”). Зазвичай для цього потрібно виконати певні дії (наприклад, його приєднати до існуючого меню).admin_menuНа дієвому хвості.

Наведений нижче код демонструє, як створити просту сторінку з головними налаштуваннями:

function my_plugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',           // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',        // 所需权限（管理员）
        'my-plugin-settings',    // 菜单slug（URL标识）
        'my_plugin_settings_page', // 用于输出页面内容的回调函数
        'dashicons-admin-generic', // 图标（Dashicons）
        80                       // 菜单位置
    );
}
add_action( 'admin_menu', 'my_plugin_add_admin_menu' );

Далі вам потрібно визначити функцію-повернення (callback function).my_plugin_settings_pageЦе потрібно для відображення вмісту HTML-сторінки.

Створення форми для налаштувань та параметрів збереження

WordPressSettings APIНадає стандартизовані способи для безпечної реєстрації, підтвердження та зберігання налаштувань. Це уникає необхідності безпосереднього оброблення даних.$_POSTДані підвищили рівень безпеки.

Насамперед, використайтеregister_setting()Зареєструйте групу налаштувань та використовуйте її.add_settings_section()Додайте нову область та використовуйте її.add_settings_field()Додайте конкретні поля. Потім у раніше визначеній функції-поверненні (callback function) використовуйте ці поля.settings_fields()和do_settings_sections()Функція для виведення форми.

function my_plugin_settings_page() {
    // 检查用户权限
    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_plugin_options_group' );
            // 输出设置区域和字段
            do_settings_sections( 'my-plugin-settings' );
            // 输出提交按钮
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

проходження (законопроект, перевірка тощо)Settings APIВи можете легко створити сторінку налаштувань, яка містить текстові поля, випадаючі меню, полі для позначки галочок та багато інших елементів. Усі дані будуть безпечно збережені.wp_optionsУ таблиці можна отримати потрібну інформацію шляхом використання відповідних функцій чи методів.get_option()Функції можуть викликатися на фронтенді або на бекенді.

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

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

Проверка даних, їх ескапування та ненадійне оброблення

Це перший рівень захисту безпеки плагінів. Усі дані, що надходять від користувачів або з зовнішніх джерел (наприклад…$_GET、$_POST、$_COOKIEПеред тим, як дані потраплять до бази даних чи відображатимуться на сторінці, їх необхідно суворо перевірити та обробити процедурою ескапування.

Для перевірки даних, що вводяться (перед їх збереженням у базу даних), використовуйте функції перевірки.sanitize_text_field()、absint()Необхідно очистити дані. Для обробки вихідної інформації (яка отримується з бази даних та відображається у браузері) слід використовувати функції ескапування.esc_html()、esc_attr()、esc_url()Це робиться для запобігання атакам типу XSS (Cross-Site Scripting).

// Обробка подання форми (приклад; зазвичай це виконується API Settings у файлі options.php)
$$user_input = isset($$_POST['my_field']) ? sanitize_text_field($$_POST['my_field']) : '';

// Відображення даних, отриманих з бази даних, на передньому кінці
echo '<div class="info">'`. esc_html( get_option( 'my_saved_option' ) )`.'</div>';

Крім того, під час виконання запитів до бази даних необхідно використовувати…$wpdbМетоди, які надає клас (наприклад…)$wpdb->prepare()Це робиться для запобігання виконанню зловмисних запитів типу SQL-ін’єкції (SQL injection).

Реалізація підтримки інтернаціоналізації та локалізації

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

Використовуйте__()Функція для перекладу та повернення рядка, яка використовує…_e()Функція для перекладу та безпосереднього виведення рядка. Визначена у заголовковому файлі плагіна.Text Domain(Пол для введення тексту) Має бути ідентичним полу для введення тексту, який використовується тут.

// 错误示例：直接输出英文字符串
echo “Hello World”;

// 正确示例：可翻译的字符串
echo esc_html__( ‘Hello World’, ‘my-first-plugin’ );
// 或者
_e( ‘Hello World’, ‘my-first-plugin’ );

Потім ви можете використати такий інструмент, як Poedit, щоб вилучити всі марковані рядки та створити потрібний результат..potФайл, призначений для того, щоб перекладачі могли створювати тексти на різних мовах..po和.moФайл. Розмістіть його у плагіні.languagesУ цій папці WordPress автоматично завантажить відповідні переклади залежно від мови сайту.

підсумок

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

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

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

Щоб розробляти плагіни для WordPress, необхідно оволодіти такими ключовими технологіями:

Вам потрібно ознайомитися з основами мови PHP, адже плагіни переважно пишуться на цій мові. Крім того, необхідно розуміти HTML, CSS та JavaScript для створення інтерфейсів та забезпечення їх взаємодії. Найважливіше – опанувати специфіку системи WordPress, зокрема її систему хуків (Actions та Filters) та механізми роботи з базою даних.$wpdbЗнання API налаштувань, а також REST API також є дуже корисними. Крім того, розуміння пріоритетів виконання дій для тем та плагінів WordPress також допоможе ефективніше їх використовувати.

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

Насамперед, переконайтеся, що вwp-config.phpФайл увімкнений.WP_DEBUGЦей режим буде відображати PHP-помилки, попередження та сповіщення безпосередньо на сторінці. Використовуйте його за потреби.error_log()Функції можуть записувати інформацію у власні файли журналів для відстеження змінних та процесів виконання програми. Для складних викликів Ajax чи REST API можна скористатися панеллю “Мережа” у розробницьких інструментах браузера для аналізу даних. Крім того, існує багато чудових додатків-плагінів, таких як “Query Monitor”, які дозволяють детально аналізувати запити до баз даних, виконання певних дій (хаків) та місця, що спричиняють затримки в роботі програми; це дуже корисні інструменти під час розробки т

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

По-перше, вам потрібно переконатися, що код плагіна відповідає офіційним стандартам кодування та вимогам до структури каталогів WordPress. Наприклад, у плагіні має бути стандартний файл із описом плагіна („plugin.php“), який містить необхіreadme.txtСпочатку створіть файл з описом вашого плагіна. Потім зареєструйте обліковий запис розробника на сайті WordPress.org та подайте свій плагін на розгляд. Процес розгляду включає перевірку якості коду, безпеки, умов ліцензування (плагін має бути сумісним з ліцензією GPL) та опису функцій. Після схвалення ви зможете використовувати інструмент SVN для завантаження коду плагіна до офіційного SVN-репозиторію WordPress. Після цього ви зможете оновлювати версії плагіна через інтерфейс адміністрування.

У чому різниця між додаванням коду до файлу functions.php у власних плагінах та темах?

Додайте код до поточної теми.functions.phpФайли є простим способом швидкого тестування або додавання функцій, специфічних для певного сайту. Однак цей підхід має очевидні недоліки: функції прив’язані до конкретного тематичного дизайну сайту, тому їх ефективність зникає при зміні теми. Крім того, код погано інкапсульований та не має чітких імен просторів імен, що може призводити

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