Розкриття секретів розробки плагінів: створіть свій перший розширення з нуля

Розкриття секретів розробки плагінів: створіть свій перший розширення з нуля

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

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

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

Стандарти для основних файлів плагінів

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

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

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

Ця інформація буде відображатися безпосередньо на сторінці керування “Плагінами” у бекенді WordPress. Серед неї…Text Domain 和 Domain Path Застосовується для інтернаціоналізації (i18n) – це дозволяє плагіну підтримувати кілька мов.

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

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

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

Каталог плагінів та організація файлів

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

/my-first-plugin/
├── my-first-plugin.php      // 主文件
├── uninstall.php            // 卸载清理脚本
├── includes/                // 核心功能类与函数
│   ├── class-core.php
│   └── functions.php
├── admin/                   // 后台相关文件
│   ├── css/
│   ├── js/
│   └── class-admin.php
├── public/                  // 前台相关文件
│   ├── css/
│   ├── js/
│   └── class-public.php
├── assets/                  // 静态资源（图片等）
└── languages/               // 翻译文件（.po, .mo）

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

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

API плагінів WordPress ґрунтується на так званих “хвостках” (hooks), які є основою його архітектури, заснованої на обробці подій. Існує два типи хвостків: дії (actions) та фільтри (filters). Розуміння та вміле використання хвостків є ключовими аспектами розробки плагінів.

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

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

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

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

Функція myplugin_add_footer_text() {
    echo '<p style="text-align:center;">Дякуємо, що використовуєте цей плагін!</p>';
}
add_action( 'wp_footer', 'myplugin_add_footer_text' );

Коли WordPress виконує… wp_footer Коли йдеться про місцезнаходження (зазвичай у контексті теми… footer.php Коли викликається ця функція (або будь-яка інша функція, яку ми додали), наша додана функція буде виконана.

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

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

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

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

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

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

function myplugin_prefix_post_title( $title, $id = null ) {
    // 确保只在主循环且在非管理后台时添加前缀
    if ( ! is_admin() && in_the_loop() ) {
        $title = '[推荐] ' . $title;
    }
    return $title;
}
add_filter( 'the_title', 'myplugin_prefix_post_title', 10, 2 );

Параметри тут 10 Це пріоритет (чим менший номер, тим завдання виконується раніше).2 Це означає, що наша функція приймає два параметри.$title 和 $idФункція-фільтр має повертати змінене значення.

Створити сторінку керування плагінами

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

Рекомендуємо до прочитання. Повний посібник: Налаштування шаблонів сторінок товарів у WooCommerce для підвищення показників конверсії продажів。

Додати верхній меню керування

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

Наведений нижче код демонструє, як створити просту верхню меню-сторінку та забезпечити її відображення лише під час входу адміністратора.

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

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

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

function myplugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',       // 权限能力（通常为管理员）
        'myplugin-settings',    // 菜单 Slug
        'myplugin_settings_page', // 显示页面内容的回调函数
        'dashicons-admin-generic', // 图标（使用 Dashicons）
        30                      // 菜单位置
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

// 定义设置页面的内容
function myplugin_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( 'myplugin_options' ); // 输出安全字段
            do_settings_sections( 'myplugin-settings' ); // 输出设置区块
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Тут,myplugin_settings_page Функція відповідає за рендеринг вмісту HTML-сторінки. У реальних проектах ви будете поєднувати цю функцію з налаштуваннями WordPress та використовувати відповідні API (Application Programming Interfaces).register_setting, add_settings_section, add_settings_fieldВикористовуйте цей інструмент для створення форм, які можна зберігати.

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

Для безпечного та правильного оброблення даних, введених користувачами, необхідно використовувати API налаштувань WordPress. Цей API відповідає за перевірку даних (зокрема на наявність певних параметрів, таких як „CES“), їх обробку та зберігання в базі даних. Спочатку потрібно зареєструвати новий параметр налаштування, а потім додати ві

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

function myplugin_settings_init() {
    register_setting(
        'myplugin_options', // 选项组名
        'myplugin_api_key', // 选项名（存储在 wp_options 表中）
        array(
            'type' => 'string',
            'sanitize_callback' => 'sanitize_text_field', // 数据清理回调
            'default' => ''
        )
    );

    add_settings_section(
        'myplugin_section_main',
        '主要设置',
        null,
        'myplugin-settings'
    );

    add_settings_field(
        'myplugin_field_api',
        'API 密钥',
        'myplugin_field_api_cb',
        'myplugin-settings',
        'myplugin_section_main',
        array( 'label_for' => 'myplugin_api_key' )
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

function myplugin_field_api_cb() {
    $value = get_option( 'myplugin_api_key', '' );
    echo '<input type="text" id="myplugin_api_key" name="myplugin_api_key" value="' . esc_attr( $value ) . '" class="regular-text">';
}

У такий спосіб дані, надіслані через форму, піддаються певним процедурам обробки перед тим, як бути передані далі. sanitize_text_field Функція очищення даних, після чого вони автоматично зберігаються у базі даних. wp_options У таблиці назва ключа є… myplugin_api_key。

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

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

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

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

• Перевірка: Переконатися, що дані відповідають очікуваному формату (наприклад, чи є це електронна адреса чи число).
• Очищення: видалення з даних недозволених символів або контенту (наприклад, HTML-тегів).
• Ескапування: процес кодування даних під час їх виводу у HTML, JavaScript або URL-адреси з метою запобігання атакам типу XSS (Cross-Site Scripting).

WordPress надає велику кількість допоміжних функцій, наприклад:
* sanitize_text_field()Очищення текстового рядка.
* esc_html()Евкаліптизація HTML-вихідного коду.
* esc_url()Ескапування URL-адреси.
* wp_kses_post()Дозволяються HTML-теги, які використовуються для фільтрації контенту статей.

Правильне завантаження скриптів та шаблонів

Щоб не впливати на швидкість завантаження сторінки та уникнути конфліктів, файли JavaScript та CSS необхідно правильно зареєструвати та завантажити у послідовному порядку за допомогою методів, які надає WordPress. wp_enqueue_script() 和 wp_enqueue_style() Функція.

Наведений нижче код демонструє, як завантажувати власні JS- та CSS-файли лише на сторінці керування самого плагіна.

function myplugin_load_admin_assets( $hook ) {
    // 只在我们插件的设置页加载
    if ( $hook != 'toplevel_page_myplugin-settings' ) {
        return;
    }
    wp_enqueue_style(
        'myplugin-admin-css',
        plugins_url( 'admin/css/style.css', __FILE__ ),
        array(),
        '1.0.0'
    );
    wp_enqueue_script(
        'myplugin-admin-js',
        plugins_url( 'admin/js/script.js', __FILE__ ),
        array( 'jquery' ), // 声明依赖 jQuery
        '1.0.0',
        true // 在页脚加载
    );
}
add_action( 'admin_enqueue_scripts', 'myplugin_load_admin_assets' );

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

підсумок

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

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

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

Розробка плагінів для WordPress вимагає знання мови програмування PHP, адже плагіни переважно складаються з коду на PHP. Крім того, необхідно мати базові знання HTML, CSS та JavaScript для створення фронтенд-інтерфейсів та забезпечення їхньої взаємодії з користувачем. Найважливіше – розуміти основну архітектуру WordPress, зокрема систему хуків (дії та фільтри), ієрархію шаблонів тем, а також механізми роботи з базою даних. WP_Query 和 wpdb Клас (class).

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

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

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

Для зберігання простих даних рекомендується використовувати API параметрів WordPress (Options API).add_option, get_option, update_optionВикористовуйте цей механізм для зберігання даних у вигляді пар ключ-значення. Для структурованих даних, які потребують користувацького налаштування структури, ви зможете скористатися цими можливостями під час активації плагіна. dbDelta() Функції для безпечного створення або оновлення структури таблиць мають використовувати певний SQL-формат. Обов’язково дотримуйтесь цих правил під час їх застосування. $wpdb Глобальний об’єкт виконує всі запити до баз даних та використовує його метод `prepare` для запобігання атакам типу SQL-ін’єкції.

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

WordPress використовує фреймворк GNU gettext для підтримки міжнародної локалізації. Вам потрібно правильно налаштувати ці налаштування у вихідному файлі вашого плагіна (зазвичай це файл з розширенням `.php`). Для цього потрібно додати відповід Text Domain 和 Domain PathУ коді всі рядки, які потрібно перекласти, позначені символом <. __()(Використовується для повернення значення) або _e()(Для безпосереднього виведення) потрібно обгорнути цей код відповідними функціями перекладу. Потім, за допомогою інструментів на кшталт Poedit, сканувати вихідний код, щоб отримати результати перекладу. .pot Шаблонний файл, на основі якого створюються версії продукту для різних мов. .po 和 .mo Перекладіть файл та розмістіть його у вказаному місці. Domain Path У каталозі.

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

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