Как преобразовать PHP скрипт в плагин WordPress: пошаговое руководство

Представьте, у вас есть мощный PHP-скрипт, который выполняет, скажем, сложные вычисления эффективности рекламной кампании на основе данных из Google Analytics и Yandex.Direct API. Или, возможно, это скрипт, автоматизирующий A/B тестирование заголовков статей. Вместо того, чтобы копаться в файлах темы WordPress и рисковать нарушить её работу, вы можете превратить этот скрипт в плагин. Это позволит вам легко устанавливать, активировать, деактивировать и обновлять ваш скрипт, не затрагивая ядро WordPress или другие темы и плагины.

Преимущества создания плагина WordPress из PHP-скрипта

Управляемость: Плагины легко устанавливать, активировать, деактивировать и удалять через админ-панель WordPress.

Безопасность: Плагины работают в изолированной среде, что снижает риск конфликтов с другими плагинами или темой.

Переносимость: Плагин можно легко перенести на другой сайт WordPress.

Обновления: Легко обновлять функциональность через механизм обновлений WordPress.

Расширяемость: Можно добавлять новые функции и настройки плагина.

Когда стоит преобразовывать скрипт в плагин, а когда – нет

Преобразовывать скрипт в плагин стоит, если:

Скрипт выполняет специфическую задачу, не связанную напрямую с темой оформления.

Вы планируете повторно использовать скрипт на разных сайтах WordPress.

Вы хотите предоставить скрипт другим пользователям WordPress.

Скрипт требует настроек и параметров, которые лучше хранить в базе данных WordPress.

Преобразовывать скрипт в плагин не стоит, если:

Скрипт тесно интегрирован с темой оформления и зависит от её структуры.

Скрипт является небольшим фрагментом кода, который легко добавить непосредственно в файлы темы (хотя это и не рекомендуется).

Скрипт используется только на одном сайте и не требует сложной настройки.

Подготовка к преобразованию: Шаги перед началом

Анализ существующего PHP-скрипта и его функциональности

Первым шагом является детальный анализ существующего PHP-скрипта. Понимание логики работы скрипта, используемых функций и переменных необходимо для успешного преобразования в плагин. Обратите внимание на:

Входные и выходные данные скрипта.

Используемые сторонние библиотеки или API.

Зависимости от других файлов или ресурсов.

Обработку ошибок и исключений.

Определение необходимых функций и хуков WordPress

Определите, какие функции и хуки WordPress необходимы для интеграции скрипта. Например, если скрипт должен выполняться при загрузке страницы, потребуется использовать хук wp_enqueue_scripts. Если скрипт должен добавлять информацию в админ-панель, понадобятся хуки для создания меню и страниц настроек. Подумайте, какие actions и filters WordPress могут быть полезны.

Создание структуры директорий плагина

Создайте структуру директорий для плагина. Рекомендуется использовать следующую структуру:

plugin-name/
├── plugin-name.php      # Основной файл плагина
├── includes/          # Файлы с функциями плагина
├── admin/             # Файлы для админ-панели
│   ├── class-plugin-name-admin.php # Класс для админ-панели
│   ├── views/           # Шаблоны для админ-панели
│   └── assets/          # CSS и JavaScript для админ-панели
├── public/            # Файлы для публичной части сайта
│   ├── assets/          # CSS и JavaScript для публичной части сайта
├── languages/         # Файлы локализации
└── readme.txt          # Файл с информацией о плагине

Пошаговая инструкция: Преобразование PHP-скрипта в плагин WordPress

Создание основного файла плагина (plugin-name.php)

Создайте основной файл плагина с именем, соответствующим названию плагина (например, my-awesome-plugin.php). Этот файл будет точкой входа для WordPress.

Добавление заголовка плагина с информацией (название, автор, версия)

В начале основного файла добавьте заголовок плагина в виде комментариев PHP:

<?php
/**
 * Plugin Name:  My Awesome Plugin
 * Plugin URI:   https://example.com/my-awesome-plugin/
 * Description:  This plugin calculates advertising campaign effectiveness.
 * Version:      1.0.0
 * Author:       Your Name
 * Author URI:   https://example.com/
 * License:      GPL2
 * License URI:  https://www.gnu.org/licenses/gpl-2.0.html
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

// Rest of the plugin code goes here...

Регистрация хуков активации и деактивации плагина

Зарегистрируйте хуки активации и деактивации плагина. Эти хуки позволяют выполнять определенные действия при активации и деактивации плагина, например, создание таблиц в базе данных или удаление настроек.

/**
 * Function triggered when the plugin is activated.
 */
function my_awesome_plugin_activate(): void {
    // Perform actions on plugin activation, like creating database tables.
    // Example: require_once plugin_dir_path( __FILE__ ) . 'includes/class-my-awesome-plugin-activator.php';
    //       My_Awesome_Plugin_Activator::activate();
}
register_activation_hook( __FILE__, 'my_awesome_plugin_activate' );

/**
 * Function triggered when the plugin is deactivated.
 */
function my_awesome_plugin_deactivate(): void {
    // Perform actions on plugin deactivation, like deleting plugin options.
    // Example: require_once plugin_dir_path( __FILE__ ) . 'includes/class-my-awesome-plugin-deactivator.php';
    //       My_Awesome_Plugin_Deactivator::deactivate();
}
register_deactivation_hook( __FILE__, 'my_awesome_plugin_deactivate' );

Использование хуков WordPress для интеграции скрипта (actions, filters)

Используйте хуки WordPress для интеграции вашего PHP-скрипта. Например, чтобы добавить функциональность скрипта на определенной странице, используйте хук the_content:

/**
 * Modifies the content of posts and pages.
 *
 * @param string $content The content of the post/page.
 *
 * @return string The modified content.
 */
function my_awesome_plugin_filter_the_content( string $content ): string {
    if ( is_singular( 'post' ) ) {
        // Perform calculations based on data from Google Analytics API (example).
        // $ga_data = get_google_analytics_data( get_the_ID() );
        // $effectiveness = calculate_effectiveness( $ga_data );

        // Add effectiveness information to the content.
        $content .= '
Effectiveness: ' . 'TBD' . '
';
    }

    return $content;
}
add_filter( 'the_content', 'my_awesome_plugin_filter_the_content' );

Работа с данными и настройками плагина

Сохранение и получение настроек плагина (options API)

Для хранения настроек плагина используйте Options API WordPress. Это позволяет сохранять и получать данные в базе данных WordPress.

/**
 * Saves a plugin option.
 *
 * @param string $option_name The name of the option to save.
 * @param mixed  $option_value The value to save.
 */
function my_awesome_plugin_save_option( string $option_name, mixed $option_value ): void {
    update_option( $option_name, $option_value );
}

/**
 * Retrieves a plugin option.
 *
 * @param string $option_name The name of the option to retrieve.
 *
 * @return mixed The value of the option, or false if it doesn't exist.
 */
function my_awesome_plugin_get_option( string $option_name ): mixed {
    return get_option( $option_name );
}

Создание страницы настроек плагина в админ-панели WordPress

Создайте страницу настроек плагина в админ-панели WordPress, чтобы пользователи могли настраивать параметры плагина. Используйте хуки admin_menu и функции для создания меню и страницы настроек.

/**
 * Adds the admin menu.
 */
function my_awesome_plugin_add_admin_menu(): void {
    add_menu_page(
        'My Awesome Plugin Settings', // Page title
        'Awesome Plugin',           // Menu title
        'manage_options',            // Capability
        'my-awesome-plugin',         // Menu slug
        'my_awesome_plugin_settings_page' // Callback function
    );
}
add_action( 'admin_menu', 'my_awesome_plugin_add_admin_menu' );

/**
 * Displays the settings page.
 */
function my_awesome_plugin_settings_page(): void {
    // Include the settings page template.
    include_once plugin_dir_path( __FILE__ ) . 'admin/views/settings-page.php';
}

Безопасность данных: Валидация и санитизация

Валидируйте и санитизируйте все входные данные, чтобы предотвратить XSS и SQL-инъекции. Используйте функции WordPress, такие как sanitize_text_field() и esc_attr().

Тестирование и отладка плагина

Установка и активация плагина в WordPress

Загрузите плагин в директорию /wp-content/plugins/ и активируйте его через админ-панель WordPress.

Проверка функциональности и исправление ошибок

Проверьте работу плагина на разных страницах и в разных ситуациях. Исправьте все обнаруженные ошибки.

Использование инструментов отладки WordPress (WP_DEBUG)

Включите режим отладки WordPress (WP_DEBUG), чтобы видеть ошибки и предупреждения PHP. Это поможет вам обнаружить и исправить проблемы в вашем плагине. Добавьте следующую строку в файл wp-config.php:

define( 'WP_DEBUG', true );

Преобразование PHP-скрипта в плагин WordPress — это мощный способ организовать и расширить функциональность вашего сайта. Следуя этому пошаговому руководству, вы сможете легко превратить свои скрипты в надежные и удобные плагины.