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

Основи плагінів для WordPress та середовище розробки

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

Щоб розпочати розробку, вам знадобиться локальне середовище розробки. Воно зазвичай включає в себе локальний сервер (наприклад, XAMPP, MAMP або Local by Flywheel), PHP (версія якої має відповідати вимогам WordPress), базу даних MySQL та текстовий редактор (наприклад, VS Code абоPhpStorm). Дуже рекомендується виконувати розробку та налагодження в локальному середовищі, щоб уникнути можливого впливу на онлайн-сайт.

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

Найпростіший плагін може містити лише один файл. Однак для зрозумілості та легкості обслуговування коду рекомендується дотримуватися певної структури. Типовий каталог плагіна може включати: основний файл плагіна (наприклад…your-plugin-name.phpОдин, один…includesПапка (для зберігання класів чи функцій, що виконують основні функції), однаadminПапка (для зберігання коду, пов’язаного з бекендом), однаpublicПапка (для зберігання коду, пов’язаного з фронтендом), однаassetsПапка (для зберігання JavaScript-коду, CSS-файлів та зображень), а також (за бажанням) папки з мовними пакетами та шаблонами.

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

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

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

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

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

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

Давайте почнемо з класичного прикладу “Hello World”. Це допоможе вам ознайомитися з основними етапами та стандартами створення плагінів.

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

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

Відкрийте цей файл та введіть наступний код. Блок інформації про плагін на початку (Plugin Header) є обов’язковим; він повідомляє WordPress, що це плагін.

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://example.com/my-first-plugin
 * Description:       这是一个学习插件开发的示例插件，它将在文章内容顶部显示“Hello World!”。
 * Version:           1.0.0
 * Author:            你的名字
 * Author URI:        https://example.com
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 * Domain Path:       /languages
 */

// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

/**
 * 在文章内容前添加“Hello World”
 *
 * @param string $content 原始文章内容。
 * @return string 修改后的文章内容。
 */
function mfp_add_hello_world( $content ) {
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = &#039;<p style="background-color:#f0f0f0; padding:10px;"><strong>Привіт, світ! Це мій перший плагін.</strong></p>';
        return $custom_text . $content;
    }
    return $content;
}
add_filter( 'the_content', 'mfp_add_hello_world' );

Після збереження файлу увійдіть у свій обліковий запис WordPress, перейдіть на сторінку “Плагіни” (Plugins). Там ви повинні побачити плагін “Мій перший плагін” у списку плагінів. Активуйте його, а потім перейдіть на будь-яку статтю на вашому сайті. Ви помітите, що рядок “Hello World!” було додано до початку вмісту статті.

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

Розуміння ключових елементів коду

Цей код демонструє основну концепцію розробки в WordPress – фільтри (Filters). Ми визначили функцію…mfp_add_hello_worldВоно отримує вміст статті.$contentЯк параметр, і повертаємо змінене значення. Потім ми використовуємо це значення для подальших дій.add_filter()Функція монтує цю власну функцію в ядро WordPress.the_contentЦей фільтр підключений до відповідних механізмів WordPress. WordPress виконує необхідні дії під час роботи з цим фільтром.the_content()У цей момент будуть послідовно виконані всі функції, прикріплені до цього хука, що дає нам можливість змінити результат виконання програми.

Умовні перевірки в кодіis_single() && in_the_loop() && is_main_query()Це робиться для того, щоб переконатися, що наші зміни впливають лише на конкретну статтю у основному запиті, а не на сторінку списку статей чи інші частини сайту. Це важлива практика під час створення ефективних та безпечних додатків (плагіні

Технології основного розроблення плагінів

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

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

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

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

Використання дійових хуків (action hooks) та фільтрів-хуків (filter hooks)

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

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

function mfp_create_custom_table() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'my_custom_data';
    $charset_collate = $wpdb->get_charset_collate();

$sql = "CREATE TABLE IF NOT EXISTS $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        data varchar(255) NOT NULL,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}
register_activation_hook( __FILE__, 'mfp_create_custom_table' );

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

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

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

Надання сторінки налаштувань у бекенді для вашого плагіна є ознакою професійного плагіна. Використання API налаштувань WordPress дозволяє створювати сторінки з параметрами безпечним та стандартизованим способом.

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

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

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

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

// 在管理后台初始化时添加菜单
add_action( 'admin_menu', 'mfp_add_admin_menu' );

function mfp_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',        // 所需权限
        'my-plugin-settings',    // 菜单slug
        'mfp_render_settings_page' // 用于渲染页面的回调函数
    );
}

function mfp_render_settings_page() {
    ?>
    <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( 'mfp_settings_group' ); // 输出安全字段
            do_settings_sections( 'my-plugin-settings' ); // 输出设置区域
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    <?php
}

// 初始化设置
add_action( 'admin_init', 'mfp_settings_init' );

function mfp_settings_init() {
    register_setting( 'mfp_settings_group', 'mfp_options' ); // 注册一个设置选项组

add_settings_section(
        'mfp_section_basic',
        '基本设置',
        null,
        'my-plugin-settings'
    );

add_settings_field(
        'mfp_field_text',
        '示例文本框',
        'mfp_field_text_render',
        'my-plugin-settings',
        'mfp_section_basic'
    );
}

function mfp_field_text_render() {
    $options = get_option( 'mfp_options' );
    ?>
    <input type='text' name='mfp_options[text_field]' value='<?php echo esc_attr( $options['text_field'] ?? '' ); ?>'>
    <p class="description">Це приклад текстового поля.</p>
    &lt;?php
}

Безпека плагінів, їх інтернаціоналізація та підготовка до публікації

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

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

Ніколи не довіряйте даним, введеним користувачем, або даним ззовні. Усі дані, які надходять ззовні, потрібно перевіряти та обробляти з обережністю.$_GET、$_POST、$_REQUESTДані, отримані з баз даних, або з інших джерел, повинні піддаватися перевірці (validation) та обробці (escaping) перед їх використанням.

• Перевірка: Переконатися, що дані відповідають очікуваному формату (наприклад, чи є це електронна адреса, число тощо). Для цього використовуються такі функції, як…is_email()、intval()、sanitize_text_field()。
• Ескапування: Під час виведення даних у HTML, JavaScript або URL необхідно переконатися, що спеціальні символи оброблені правильно, щоб уникнути атак типу XSS. Для цього використовуються відповідні функції.esc_html()、esc_js()、esc_url()、wp_kses_post()。

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

Інтернаціоналізація плагінів

Інтернаціоналізація (i18n) дозволяє вашому плагіну бути перекладеним на інші мови. Для цього потрібно виконати два кроки: позначити рядки, які можна перекласти, та завантажити відповідні текстові файли.

По-перше, у вихідному файлі основного плагіна все вже визначено на початку файлу.Text Domain和Domain PathПотім, у всіх місцях у плагіні, де потрібно перекласти текст, використовуйте функцію перекладу для обгортання цього тексту. Наприклад:__('Hello World', 'my-first-plugin')Використовується для відображення перекладів у PHP.esc_html_e('Settings', 'my-first-plugin')Використовується для ескапування та відображення символів у їхньому початковому вигляді.

Під час ініціалізації плагіна (наприклад, під час його використання…)initДля виконання цієї дії необхідно завантажити файл з перекладами.

function mfp_load_textdomain() {
    load_plugin_textdomain( 'my-first-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}
add_action( 'init', 'mfp_load_textdomain' );

Після цього ви можете використовувати такі інструменти, як Poedit, для створення потрібних файлів..potШаблонний файл, призначений для створення перекладів користувачами..po/.moМовні файли.

Підсумкова перевірка та пакування

Перед публікацією, будь ласка, виконайте наступні перевірки:
1. Код відповідає стандартам кодування WordPress.
2. Усі функції пройшли ретельне тестування, включаючи їх активацію, деактивацію та видалення (за потреби).register_uninstall_hookОчищення даних.
3. Був видалений весь діагностичний код та тимчасовий вивід даних.
4. Було створено детальний опис/план.readme.txtФайл має відповідати офіційним вимогам WordPress; він буде відображатися на сторінці каталогу плагінів.
5. Переконайтеся, що назви каталогів плагінів та основних файлів є унікальними, щоб уникнути конфліктів з іншими плагінами.

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

підсумок

Розробка плагінів для WordPress – це процес перетворення ідей на функціональні рішення, який ґрунтується на глибокому розумінні основної архітектури WordPress (особливо API-інтерфейсів). Починаючи зі створення простого плагіна на кшталт “Hello World”, ви поступово вивчаєте, як створювати інтерфейси керування, безпечно обробляти дані, взаємодіяти з базами даних та реалізовувати механізми інтернаціоналізації. Це шлях розвитку кожного розробника плагінів. Дотримання стандартів безпечного програмування, використання таких інтерфейсів, як API для налаштувань (Settings API), є ключовим для забезпечення якості, сумісності та безпеки плагінів. Завдяки постійній практиці та вивченню вихідного коду WordPress та інших якісних плагінів ви зможете створювати професійні, надійні та популярні розширення для цього системного фреймворку.

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

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

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

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

Насамперед, переконайтеся, що вwp-config.phpФайл увімкнений.WP_DEBUG和WP_DEBUG_LOGТаким чином повідомлення про помилки будуть зберігатися у файлі журналу (логах), а не відображатися безпосередньо відвідувачам. Крім того, можна використовувати…error_log()Функція записує власну інформацію про налагодження до журналу. Для складної логіки найефективнішим способом є використання професійних інструментів налагодження, таких як Xdebug, у поєднанні з інтегрованими середовищами розробки (IDE), наприклад, PhpStorm.

Як мій плагін може взаємодіяти з третіми сервісами (наприклад, API)?

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

Як слід називати класи та функції у плагінах, щоб уникнути конфліктів?

Щоб уникнути конфліктів із іменами функцій та класів інших плагінів чи тем, необхідно використовувати унікальні префікси. Зазвичай рекомендується використовувати або скорочення назви плагіна, або його повну назву як префікс. Наприклад, якщо ваш плагін називається “Super Tool”, іstool_save_data()Класи можуть мати назви, які…Super_Tool_AdminІнший, більш сучасний та безпечний спосіб – використання просторів імен (Namespaces) у PHP. Для цього необхідно, щоб середовище виконання вашого плагіна підтримувало PHP версії 5.3 або вищі.