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

Підготовчі роботи перед розробкою

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

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

Щиро рекомендуємо не розробляти плагіни на продуктивних серверах. Використання локального середовища розробки дозволяє вам сміливо експериментувати, не хвилюючись про можливі збої сайту. Ви можете скористатися такими інструментами, як XAMPP, MAMP, Local by Flywheel чи Docker, щоб швидко налаштувати на своєму комп’ютері середовище для роботи WordPress з встановленими серверами Apache/Nginx, базою даних MySQL та мовою програмування PHP. Це значно прискорить процеси змін та налагодження коду.

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

Найпростіший плагін для WordPress може містити лише один головний файл. Цей головний файл повинен містити певну коментарну рядок на початку („header comment“), яка інформує систему WordPress про основні властивості плагіна. Наприклад, плагін під назвою „My Simple Plugin“ може виглядати ось так:my-first-plugin.phpЗміст файлу може виглядати так:

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

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

Помістіть цей файл у відповідне місце./wp-content/plugins/У каталозі ви зможете побачити цей плагін на сторінці “Плагіни” у веб-інтерфейсі WordPress та активувати його. Ось так виглядає найпростіший варіант плагіна – хоча наразі він ще не має жодних функцій.

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

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

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

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

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

Визначте головну функцію плагіна.

Нам потрібно створити функцію для генерації та виведення інформації про авторські права. Ми назвемо її…myplugin_add_copyright_textУсередині цієї функції отримується інформація про поточну статтю, яка потім об’єднується у текст заяви про авторські права.

function myplugin_add_copyright_text( $content ) {
    if ( is_single() ) {
        $current_year = date( 'Y' );
        $copyright_text = '<p class="myplugin-copyright">© '$current_year'. Усі права захищені. Ця стаття вперше була опублікована на моєму веб-сайті.</p>';
        $content .= $copyright_text;
    }
    return $content;
}

Використовуйте хаки (hooks) для підключення функцій до WordPress.

Окремі функції не виконуються автоматично. Нам потрібно використовувати “фільтрові хаки” (Filter Hooks) WordPress, щоб прикріпити нашу функцію до процесу відображення вмісту статей. Ось як це зробити…the_contentЦей фільтр.

add_filter( 'the_content', 'myplugin_add_copyright_text' );

Об'єднайте вищезгаданий заголовок файлу та ці два фрагменти коду в один.phpУ файлі є плагін із базовими функціями. Він додає розділ із інформацією про авторські права, який містить поточний рік, після основного тексту окремої статті.

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

Додайте базовий стиль до вихідного контенту.

Щоб інформація про авторські права виглядала більш естетично, ми можемо додати до неї деякі прості CSS-стилі. Найкращою практикою є…wp_enqueue_styleНеобхідно створити функцію для чергового завантаження таблиць стилів, щоб вони завантажувалися лише тоді, коли це дійсно необхідно.style.cssІ зареєструйте його у основному файлі плагіна.
Додайте наступний код до основного файлу плагіна:

function myplugin_enqueue_styles() {
    wp_enqueue_style( 'myplugin-style', plugins_url( 'css/style.css', __FILE__ ) );
}
add_action( 'wp_enqueue_scripts', 'myplugin_enqueue_styles' );

Потім створіть файл у каталозі плагінів.css/style.cssФайл, а також додавання стилів:

.myplugin-copyright {
    font-size: 0.9em;
    color: #666;
    border-top: 1px solid #eee;
    padding-top: 10px;
    margin-top: 20px;
}

Реалізація параметрів налаштування плагіна

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

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

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

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

Створити сторінку меню налаштувань для бекенду

Спочатку нам потрібно додати підменю до меню “Налаштування” у адміністративній панелі WordPress. Для цього необхідно використати відповідні інструменти та параметри системи.add_options_pageФункція.

function myplugin_add_settings_page() {
    add_options_page(
        '版权插件设置', // 页面标题
        '版权设置',     // 菜单标题
        'manage_options', // 权限
        'myplugin-settings', // 菜单slug
        'myplugin_render_settings_page' // 用于输出页面内容的回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_settings_page' );

Налаштування реєстрації, блоки та поля

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

function myplugin_register_settings() {
    register_setting( 'myplugin_settings_group', 'myplugin_copyright_text' );
    add_settings_section( 'myplugin_main_section', '主要设置', null, 'myplugin-settings' );
    add_settings_field( 'myplugin_text_field', '版权文本', 'myplugin_render_text_field', 'myplugin-settings', 'myplugin_main_section' );
}
add_action( 'admin_init', 'myplugin_register_settings' );

// 渲染文本字段的函数
function myplugin_render_text_field() {
    $option_value = get_option( 'myplugin_copyright_text', '© [year] 版权所有。本文首发于我的网站。' );
    echo '<input type="text" name="myplugin_copyright_text" value="' . esc_attr( $option_value ) . '" class="regular-text" />'echo '<p class="description">Ви можете використовувати замінники. <code data-no-auto-translation="">[year]</code> Це позначає поточний рік.</p>';
}

Зокрема,myplugin_render_settings_pageФункція відповідає за генерацію HTML-структури форми для всього сторінки налаштувань.

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

Змініть головну функцію так, щоб вона підтримувала динамічний текст.

Зараз нам потрібно змінити початкову основну функцію (main function).myplugin_add_copyright_textНехай цей процес зчитує з бази даних текст, встановлений користувачем, та замінить всі місця, позначені підстановними символами.

function myplugin_add_copyright_text( $content ) {
    if ( is_single() ) {
        $text = get_option( 'myplugin_copyright_text', '© [year] 版权所有。本文首发于我的网站。' );
        $text = str_replace( '[year]', date( 'Y' ), $text );
        $copyright_text = '<p class="myplugin-copyright">'. $text . '</p>';
        $content .= $copyright_text;
    }
    return $content;
}

Випуск та підтримка плагінів

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

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

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

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

Виконайте пакування та публікацію відповідно до стандартів.

在wp-content/plugins/У каталозі ваш плагін має знаходитися у окремій папці, наприклад:my-first-plugin/У цьому папці зазвичай міститься принаймні основний файл плагіна.my-first-plugin.phpОдинREADME.txt(Опис плагіна та способу його встановлення), а також можливі проблеми під час використання.assets(Зображення)includes(Додатковий PHP-файл)js、cssСтворіть підкаталоги, якщо це необхідно. Переконайтеся, що структура файлів є чіткою та зрозумілою.

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

Забезпечення безпеки плагінів

Безпека має надзвичайно важливе значення. Завжди перевіряйте, очищуйте та ескапуйте дані, введені користувачами, а також динамічні дані.
1. 验证（Validation）：检查数据是否符合预期的格式（如是否为邮箱、数字）。
2. 清理（Sanitization）：在将数据存入数据库或用于其他操作前，移除其中的不安全字符。对于表单输入，使用sanitize_text_field或sanitize_textarea_field。
3. Ескапування (Escaping): Під час виведення даних з бази даних на HTML-сторінку необхідно переконатися, що всі спеціальні символи були правильно перетворені, щоб запобігти атакам типу XSS. Для цього використовуються відповідні механізми ескапуванняesc_html、esc_attr或wp_kses_post。
Наприклад, під час виведення параметрів налаштувань у форму ми використовували…esc_attr：

echo '<input ... value="' . esc_attr( $option_value ) . '" ... />';

Планування майбутніх шляхів оновлень

Встановіть для вашого плагіна чіткий номер версії (наприклад, 1.0.0), дотримуючись принципів семантичного контролю версій. Кожного разу під час оновлення внесіть зміни у коментар на початку основного файлу плагіна.VersionІнформація.
Якщо під час оновлення плагіна необхідно змінити структуру бази даних або мігрувати дані, можна скористатися механізмом оновлення WordPress. Ви можете порівняти…get_option( ‘myplugin_version’ )Зберігаються номери старих версій, порівняння яких з номером поточної версії дозволяє виконати завдання оновлення при виявленні змін у версії програмного забезпечення.
Підтримуйте сумісність плагінів із найновішими версіями WordPress та PHP, регулярно проводьте тести та постійно вдосконалюйте їх на основі відгуків користувачів.

підсумок

Розробка плагінів для WordPress – це процес перетворення ідей на функціональні рішення, які покращують можливості веб-сайту. Починаючи з створення простого плагіна…phpФайл починається з інтеграції функцій за допомогою дійових (action) та фільтрувальних (filter) хуків, створення користувацького інтерфейсу налаштувань за допомогою API Settings, а на завершення – з дотриманням стандартів безпеки та правил версійного контролю під час публікації та обслуговування продукту. Кожен крок ґрунтується на принципах модульності та стандартизації розробки. Ключовим моментом є глибоке розуміння системи хуків та API WordPress, а також постійне наголос на безпеці та якості користувацького досвіду. Опанувавши ці основи, ви зможете створювати потужні інструменти, які відповідають конкретним потребам, та реально реалізовувати ідеї від нуля.

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

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

Вам потрібні базові знання мови програмування PHP, адже вона є основною мовою розробки WordPress. Також необхідно мати базове розуміння HTML, CSS та JavaScript для роботи з фронтенд-частиною сайту (її виглядом та взаємодією з користувачем). Важливо ознайомитися з основними концепціями баз даних MySQL (наприклад, засобами виконання запитів), а також з основними функціями та механізмами WordPress, такими як гаки (Actions та Filters), а також з поширеними API (наприклад, Options API).

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

Існує кілька ефективних методів налагодження під час розробки плагінів для WordPress. По-перше, переконайтеся, що…wp-config.phpФайл увімкнений.WP_DEBUG和WP_DEBUG_LOGТаким чином, помилки та інформація будуть записуватися./wp-content/debug.logУ файлі слід уникати прямого відображення інформації користувачеві. Крім того, цю інформацію можна широко використовувати в різних цілях.error_log()Функція виводить інформацію про змінні у журнал подій. Крім того, використання інструментів розробника браузера (вкладки Console та Network) для перевірки помилок JavaScript на передньому кінці та запитів до API, а також використання професійних інтегрованих середовищ розробки (наприклад, PHPStorm, VS Code) для налагодження коду з використанням точок зупинки є дуже ефективними методами.

Чи можуть плагіни використовувати API сторонніх постачальників?

Цілком можливо. Плагіни для WordPress можуть використовувати API сторонніх сервісів (наприклад, для отримання прогнозів погоди, підключення до соціальних мереж чи обробки платежів). Під час використання таких API необхідно застосовувати функції HTTP API, які надає сам WordPress.wp_remote_get()、wp_remote_post()Вони кращі за вбудовані функції PHP cURL чи…file_get_contentsБільш безпечно; вбудовані механізми тайм-ауту, переспробувань тощо. Обов’язково потрібно враховувати можливі невдачі під час викликів API (наприклад, через тайм-аут мережі, повернення помилкових кодів), а також ретельно перевіряти та очищувати отримані дані для забезпечення їх безпеки

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

WordPress використовує технологічний стек GNU gettext для підтримки інтернаціоналізації (i18n) та локалізації. У вашому плагіні всі тексти, які потребують перекладу, мають бути обгорнуті відповідними функціями.__('文本', 'my-plugin-textdomain')Використовується для повернення перекладеного рядка._e('文本', 'my-plugin-textdomain')Використовується для прямого виводу. Вам потрібно визначити цей параметр у вихідному файлі плагіна.Text DomainІ використовуйтеload_plugin_textdomain()Функція виконується у правильний момент (наприклад,initДія: завантажити файл з перекладами. Потім, за допомогою такого інструменту, як Poedit, створити необхідні файли для зберігання перекладів..potЦе шаблонний файл, призначений для того, щоб перекладачі могли створювати тексти на різних мовах..po和.moДокументи.

Що потрібно враховувати під час розробки комерційних плагінів?

Розробка комерційних плагінів вимагає більшої професійності. Якість коду, архітектура, безпека та продуктивність мають відповідати вищим стандартам. Вам потрібно розробити чітку систему перевірки ліцензій (зазвичай за допомогою власного сервера або сервісів третіх сторін). Надання професійної технічної документації, посібників для користувачів та доступних каналів технічної підтримки є надзвичайно важливим. Вбудовування механізму автоматичного оновлення плагінів (за допомогою власного сервера, а не WordPress.org) дозволяє користувачам легше отримувати нові версії та патчі. Крім того, необхідно чітко визначити умови використання плагіна, політику конфіденційності та переконатися, що плагін дотримується таких законів про захист даних, як GDPR.