Собственные плагины WordPress: от идеи до реализации

Как добавить страницу настроек в админку?

Для создания собственного пункта меню с настройками используется функция add_options_page() (или add_menu_page()). Пример простого плагина с опцией:

<?php
/*
Plugin Name: Плагин с настройками
*/

// Добавляем пункт меню в админку
add_action('admin_menu', 'my_settings_menu');

function my_settings_menu(){
    add_options_page(
        'Настройки моего плагина',
        'Мой плагин',
        'manage_options',
        'my-plugin-settings',
        'my_settings_page_html'
    );
}

// HTML страницы настроек
function my_settings_page_html(){
    ?>
    <div class="wrap">
        <h1>Настройки моего плагина</h1>
        <form action="options.php" method="post">
            <?php settings_fields('my_plugin_settings_group'); ?>
            <?php do_settings_sections('my-plugin-settings'); ?>
            <?php submit_button(); ?>
        </form>
    </div>
    <?php
}

// Регистрируем настройку
add_action('admin_init', 'my_plugin_register_settings');
function my_plugin_register_settings(){
    register_setting('my_plugin_settings_group', 'my_plugin_option');
    add_settings_section('my_plugin_main_section', 'Основные параметры', null, 'my-plugin-settings');
    add_settings_field('my_plugin_option_field', 'Текст сообщения', 'my_plugin_option_field_cb', 'my-plugin-settings', 'my_plugin_main_section');
}

function my_plugin_option_field_cb(){
    $value = get_option('my_plugin_option', '');
    echo '<input type="text" name="my_plugin_option" value="'.esc_attr($value).'" />';
}

Как создать шорткод для вставки динамического содержимого в записи?

Шорткоды позволяют пользователям вставлять функции плагина прямо в текст. Регистрация шорткода выполняется через add_shortcode().

<?php
/*
Plugin Name: Шорткод для карты
*/

add_shortcode('my_map', 'my_map_shortcode_handler');

function my_map_shortcode_handler($atts, $content = null){
    $atts = shortcode_atts(array(
        'lat' => '55.751244',
        'lng' => '37.618423',
        'zoom' => 10
    ), $atts);

    $lat = esc_attr($atts['lat']);
    $lng = esc_attr($atts['lng']);
    $zoom = intval($atts['zoom']);

    return '<div id="map" style="width:100%; height:400px;" data-lat="'.$lat.'" data-lng="'.$lng.'" data-zoom="'.$zoom.'"></div>';
}

Использование в записи: [my_map lat="55.751244" lng="37.618423" zoom="12"]. Шорткод возвращает HTML, который затем обрабатывается JavaScript карты.

Как расширить REST API WordPress собственным эндпоинтом?

Для добавления кастомных маршрутов используется класс WP_REST_Server и функция register_rest_route().

<?php
/*
Plugin Name: REST кастомный эндпоинт
*/

add_action('rest_api_init', function(){
    register_rest_route('myplugin/v1', '/data/', array(
        'methods' => 'GET',
        'callback' => 'my_rest_data_callback',
        'permission_callback' => '__return_true'
    ));
});

function my_rest_data_callback($request){
    $params = $request->get_params();
    return new WP_REST_Response(array(
        'status' => 'ok',
        'message' => 'Данные получены',
        'params' => $params
    ), 200);
}

После активации плагина по адресу /wp-json/myplugin/v1/data/ будет доступен JSON ответ. Для защиты добавьте проверку nonce или авторизацию.

Как создать виджет для боковой панели?

Виджеты регистрируются через расширение класса WP_Widget.

<?php
/*
Plugin Name: Мой виджет
*/

class My_Custom_Widget extends WP_Widget {

    public function __construct(){
        parent::__construct(
            'my_custom_widget',
            'Мой виджет',
            array('description' => 'Выводит приветствие')
        );
    }

    public function widget($args, $instance){
        echo $args['before_widget'];
        echo $args['before_title'].'Приветствие'.$args['after_title'];
        echo '<p>Здравствуйте! Спасибо за визит.</p>';
        echo $args['after_widget'];
    }

    public function form($instance){ ?>
        <p>Настроек нет</p>
    <?php }

    public function update($new_instance, $old_instance){
        return $new_instance;
    }
}

add_action('widgets_init', function(){
    register_widget('My_Custom_Widget');
});

После активации виджет появится в списке доступных виджетов в админке (Внешний вид -> Виджеты).

Как создать собственный тип записи (Custom Post Type)?

Для регистрации произвольного типа записи используется функция register_post_type().

<?php
/*
Plugin Name: Тип записи Книга
*/

add_action('init', 'my_book_post_type');

function my_book_post_type(){
    $labels = array(
        'name'               => 'Книги',
        'singular_name'      => 'Книга',
        'add_new'            => 'Добавить новую',
        'add_new_item'       => 'Добавить новую книгу',
        'edit_item'          => 'Редактировать книгу',
        'new_item'           => 'Новая книга',
        'view_item'          => 'Просмотреть книгу',
        'search_items'       => 'Искать книги',
        'not_found'          => 'Книги не найдены',
        'not_found_in_trash' => 'В корзине книг нет'
    );

    $args = array(
        'labels'      => $labels,
        'public'      => true,
        'has_archive' => true,
        'menu_icon'   => 'dashicons-book',
        'supports'    => array('title', 'editor', 'thumbnail')
    );

    register_post_type('book', $args);
}

В админке появится новый раздел «Книги» с возможностью добавлять записи. Для отображения архивов создайте файл archive-book.php в теме.