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

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

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

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

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

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

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

Зрозуміти основну структуру плагіна.

Найбазовіша плагіна для WordPress може містити лише один файл PHP. Однак структурована плагіна зазвичай складається з кількох каталогів та файлів для кращої організації коду. Типовий каталог плагіни може мати наступну структуру:
– Основний файл плагіна (наприклад…) my-first-plugin.phpЦе вхідна точка плагіна, яка містить інформацію про заголовок плагіна.
- includes/ Каталог: місце для зберігання файлів, що містять класи чи функції, які виконують основні функції програми.
- admin/ Каталог: містить код, пов’язаний з інтерфейсом адміністративного управління.
- public/ Каталог: місце для зберігання коду, призначеного для фронтенд-частини веб-сайту.
- assets/ Каталог: місце для зберігання статичних ресурсів, таких як JavaScript, CSS та зображення.
- languages/ Каталог: місце зберігання файлів з міжнародними перекладами (.po/.mo).

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

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

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

Необхідна інформація про заголовки плагінів

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

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

Зокрема,Plugin Name Це обов’язкові поля; решта поля є необов’язковими. Однак для повноцінної функціональності та зручності обслуговування плагіна рекомендується заповнити всю необхідну інформацію.Text Domain Використовується для інтернаціоналізації.Domain Path Вказує на каталог файлів мовної підтримки.

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

Давайте попрактикуємося на конкретному прикладі. Ми створимо плагін, який відображатиме на початку статей на сайті налаштоване повідомлення-вітання.

Створіть файл плагіна та відповідну директорію для нього.

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

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

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

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

/**
 * 在文章内容前添加问候语
 *
 * @param string $content 原始的文章内容。
 * @return string 修改后的文章内容。
 */
function mgp_add_greeting_to_content( $content ) {
    $greeting_text = get_option( 'mgp_greeting_text', '欢迎阅读！' ); // 从数据库获取设置，默认为“欢迎阅读！”
    $custom_greeting = '<div class="mgp-greeting"><p><strong>'`. esc_html($greeting_text)`.'</strong></p></div>';

// 仅对主循环中的单篇文章页面生效
    if ( is_single() &amp;&amp; in_the_loop() &amp;&amp; is_main_query() ) {
        return $custom_greeting . $content;
    }
    return $content;
}
// 将函数挂载到 `the_content` 过滤器
add_filter( 'the_content', 'mgp_add_greeting_to_content' );

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

Створення простої сторінки для налаштування менеджменту

Щоб користувачі могли самостійно налаштовувати текст вітань, нам потрібно додати просту сторінку налаштувань. Для цього буде необхідно використовувати API меню адміністрування WordPress. Додайте наступний код до основного файлу плагіна:

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

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

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

/**
 * 注册插件设置菜单和页面
 */
function mgp_register_admin_menu() {
    add_options_page(
        '问候语设置',           // 页面标题
        '问候语插件设置',       // 菜单标题
        'manage_options',      // 所需权限
        'my-greeting-plugin',  // 菜单slug
        'mgp_render_settings_page' // 用于输出页面内容的回调函数
    );
}
add_action( 'admin_menu', 'mgp_register_admin_menu' );

/**
 * 渲染设置页面的内容
 */
function mgp_render_settings_page() {
    ?>
    <div class="wrap">
        <h1>Налаштування плагіна привітань</h1>
        <form method="post" action="/uk/options.php/" data-trp-original-action="options.php">
            <?php
            settings_fields( 'mgp_settings_group' ); // 输出设置组和非ce字段
            do_settings_sections( 'my-greeting-plugin' ); // 输出设置区域
            submit_button(); // 输出提交按钮
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    <?php
}

/**
 * 初始化插件设置
 */
function mgp_initialize_settings() {
    // 注册一个设置
    register_setting(
        'mgp_settings_group', // 设置组名
        'mgp_greeting_text',  // 选项名，对应数据库中的键
        array( // 可选的验证回调函数
            'sanitize_callback' => 'sanitize_text_field',
            'default' =&gt; '欢迎阅读！'
        )
    );

// 添加一个设置区域
    add_settings_section(
        'mgp_main_section',           // 区域ID
        '主要设置',                   // 区域标题
        null,                         // 区域介绍的回调函数（此处不需要）
        'my-greeting-plugin'          // 页面slug
    );

// 向区域中添加一个字段
    add_settings_field(
        'mgp_greeting_field',         // 字段ID
        '问候语文本',                 // 字段标签
        'mgp_greeting_field_callback', // 用于输出字段HTML的回调函数
        'my-greeting-plugin',         // 页面slug
        'mgp_main_section'            // 区域ID
    );
}
add_action( 'admin_init', 'mgp_initialize_settings' );

/**
 * 渲染问候语文本输入字段
 */
function mgp_greeting_field_callback() {
    $greeting = get_option( 'mgp_greeting_text', '欢迎阅读！' );
    echo '<input type="text" name="mgp_greeting_text" value="' . esc_attr( $greeting ) . '" class="regular-text" />'echo '<p class="description">Цей текст буде відображатися в верхній частині кожної статті на вашому вебсайті.</p>';
}

Цей код виконує наступні завдання:
1. Використовувати add_action( 'admin_menu', ... ) До меню “Налаштування” було додано підменю.
2. Використовувати add_action( 'admin_init', ... ) Ініціалізаційні налаштування включають можливість створення бази даних, область для налаштувань та поле для введення даних.
3. Були визначені функції для налаштування форм та полів на сторінці рендерингу.
Зараз увійдіть у свій WordPress-бекенд та у меню “Налаштування” знайдіть пункт “Налаштування плагіна Привітання”. Там ви зможете змінити текст привітання та одразу побачити результати цих змін у статтях на фронтенді.

Найкращі практики та рекомендації щодо розробки плагінів

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

Безпека є найголовнішим пріоритетом.

Ніколи не довіряйте даним, введеним користувачем. У плагінах усі дані, отримані ззовні (наприклад, з інтернету чи з інших джерел), мають піддаватися певній перевірці та обробці, щоб запобігти можливим помилкам чи зл $_GET、$_POST、$_COOKIE Будь-які дані, отримані з баз даних чи інших джерел (включаючи результати запитів), перед їх виведенням чи використанням мають бути перевірені, очищені від непотрібної інформації та піддані процедурі ескапування (ескапіз
Ескапований вивід: використовуйте esc_html()、esc_attr()、esc_url() 和 wp_kses_post() Функції типу “wait” тощо.
Очищення вхідних даних: використовуйте sanitize_text_field()、sanitize_email()、intval() Функції типу “wait” тощо.
Безпека бази даних: використання $wpdb Для виконання запитів використовуються методи класів, або ж інші відповідні інструменти. prepare() Використовуйте параметризовані запити для запобігання впровадженню шкідливого коду (SQL injection).
– Перевірка прав: перед використанням функцій на сторінці керування чи виконанням секретних операцій необхідно перевірити свої права. current_user_can() Перевірте права користувача та використовуйте їх відповідно до встановлених правил. check_admin_referer() Перевірка поля nonce для запобігання підробці крос-сайтових запитів (CSRF – Cross-Site Request Forgery).

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

Реалізація інтернаціоналізації (i18n)

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

// 在插件头信息中已定义 Text Domain: my-first-plugin
$greeting_text = get_option( 'mgp_greeting_text', __( '欢迎阅读！', 'my-first-plugin' ) );

// 在管理菜单函数中
add_options_page(
    __( '问候语设置', 'my-first-plugin' ),
    __( '问候语插件设置', 'my-first-plugin' ),
    'manage_options',
    'my-greeting-plugin',
    'mgp_render_settings_page'
);

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

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

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

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

Організація коду та оптимізація продуктивності

З ростом функціоналу плагінів розбирання коду на окремі файли є розумним рішенням. Використання об’єктно-орієнтованого програмування (OOP) та класів для організації коду покращує його читабельність та забезпечує можливість повторного використання. Щодо ресурсів (CSS, JS), слід дотримуватися п wp_enqueue_style() 和 wp_enqueue_script() Функція виконується у правильному моменті (тобто у відповідному „хуку“ – hook). wp_enqueue_scripts 或 admin_enqueue_scriptsДані настороїв (settings) слід завантажувати за потреби та вказувати конкретні версії залежностей. Уникайте виконання дорогих запитів до бази даних безпосередньо у плагінах; замість цього використовуйте API Transients для кешування некритичних даних.

підсумок

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

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

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

Для функціонального WordPress-плагіна достатньо щонайменше одного PHP-файла. Головне – щоб на початку цього файлу була правильна інформація про плагін (принаймні необхідні дані для його ідентифікації). Plugin NameУ такому випадку WordPress зможе визнати цей плагін у списку плагінів на задньому плані та активувати його. У цьому файлі може міститися весь код функцій, код сторінок керування тощо. Звісно, для складних плагінів рекомендується розділити код на кілька файлів та каталогів задля кращої зберіганності та обслуговування.

Як уникнути конфліктів між плагінами, які я розробляю, та іншими плагінами?

Ключем до уникнення конфліктів є використання унікальних префіксів для найменування всіх ваших функцій, класів, змінних, імен параметрів, а також дій/фільтрів. Наприклад, не використовуйте… add_greeting() Такі універсальні назви функцій краще замінити на більш конкретні та зрозумілі. mgp_add_greeting() Такі імена (серед яких…) mgp Це скорочення вашого плагіна. Для параметрів, які зберігаються в базі даних, також слід використовувати унікальні префікси. mgp_greeting_textЦе дозволяє максимально зменшити ймовірність конфліктів імен просторів імен.

Що слід робити під час активації та деактивації плагінів?

Під час активації плагіна зазвичай необхідно виконати деякі одноразові завдання, такі як перевірка версії PHP чи WordPress, створення таблиць у базі даних, ініціалізація параметрів за замовчуванням тощо. Це можна зробити за допомогою вбудовани register_activation_hook() Функції можна реалізувати за допомогою програмного коду. Так само.register_deactivation_hook() Використовується для визначення дій, які виконуються під час деактивації плагіна (наприклад, для видалення запланованих завдань). Однак слід пам’ятати, що механізми деактивації плагінів зазвичай не призначені для видалення даних – це завдання зазвичай

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

Для додавання сторінки налаштувань до плагіна потрібно використовувати два API WordPress: API меню та API налаштувань. Спочатку… add_action( 'admin_menu', ... ) Завантажте функцію та використовуйте її всередині цієї функції. add_menu_page() 或 add_submenu_page() Зареєструйте сторінку верхнього або підменю, а потім використовуйте її для створення відповідних елементів інтерфейсу. add_action( 'admin_init', ... ) Прикріпіть іншу функцію та використовуйте її у своїй програмі. register_setting()、add_settings_section() 和 add_settings_field() Опишімо конкретні параметри налаштувань та поля форми. Нарешті, створимо функцію-повернення (callback), яка буде відповідальна за рендеринг HTML-форми сторінки налаштувань.

Який версії WordPress має бути сумісний мій плагін?

Це залежить від вашої цільової аудиторії. Зазвичай рекомендується підтримувати останні 3–4 основні версії WordPress. Ви можете вказати це у відповідній інформації в заголовку вашого плагіна. Requires at least: Вкажіть мінімальну версію WordPress, яка є обов’язковою для використання. Під час розробки слід уникати використання дуже нових функцій, які підтримуються лише останньою версією WordPress. function_exists() Виконуйте перевірки умов для запропонування альтернатив, сумісних із попередніми версіями програмного забезпечення. Крім того, регулярні тести на старіших версіях WordPress є ефективним способом забезпечення сумісності.