Создание простого плагина для WordPress

Друзья, привет-привет!

Сегодня создадим простой плагин для CMS WordPress. Будет это не стрёмная мифическая всевнушка, а простенький пак из кнопок «поделиться» для разных соцсетей и смежных сервисов. Думаете, никому не нужно? Не скажите, я то пользуюсь.

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

Вообще, программирование под CMS совсем не то же самое, что написание скрипта на заказ. Система управления контентом предоставляет богатую функциональность, но при этом диктует «правила общения». Для примера, у многих веб-программистов есть свой набор библиотек для разработки. Подключение, допустим, класса для работы с базами данных — моветон. CMS содержит эти инструменты, и глупо их не использовать. Программист, которому в будущем потребуется дополнять код, будет очень «благодарен» за нежданную возможность покопаться в чужом классе.

Дабы не заморачиваться особенностями «шаринга» разных сервисов, сделаем оболочку на основе предоставленного Яндексом блока «Поделиться». Конечно же, можно добавить три строки «шаринга» сразу в файлы темы, но плагин имеет несколько преимуществ:

1. не придётся вносить изменения в файлы index.php, single.php, page.php и прочих, если автор определил самостоятельный вывод каждого типа страницы;
2. при обновлении или изменении темы не придётся править файлы;
3. если захотите временно или навсегда скрыть кнопки, достаточно деактивировать/удалить плагин.

Простейшая реализация плагина

Если не хотите заморачиваться, вот простейшая реализация. В результате, перед каждым постом будет выводиться блок кнопок.

Создайте файл с именем YandexShareLite.php или любым другим и скопируйте в него код. После этого загрузите данный файл по фтп в каталог <корень_сайта>/wp-content/plugins/, зайдите в админку, в меню выбираете Плагины → Установленные, и жмёте ссылку Активировать для YandexShareLite.

<?php
/*
Plugin Name: YandexShareLite
Description: Добавление кнопок «поделиться» разных социальных сетей
*/

// подключим фильтр, срабатывающий перед выводом содержимого страницы (поста)
add_filter( 'the_content', 'yandexshare_run' );

// функция добавляет кнопки расшаривания перед постом
function yandexshare_run($content) {
    // код со страницы https://tech.yandex.ru/share/
    $data = '
        <script type="text/javascript" src="//yastatic.net/es5-shims/0.0.2/es5-shims.min.js" charset="utf-8"></script>
        <script type="text/javascript" src="//yastatic.net/share2/share.js" charset="utf-8"></script>
        <div class="ya-share2" data-services="vkontakte,facebook,odnoklassniki,gplus,twitter"></div>
    ';
    
    // возвращаем новое содержимое — код от Яндекса + старое содержимое
    return $data . $content;
}

Как это работает? С помощью add_filter() цепляется обработчик хука the_content. Обработчиком будет наша функция — yandexshare_run(). В качестве параметров передаётся содержимое поста. Таким образом, с ним можно делать вообще всё, что захочется. В данном случае, возвращаем код для генерации кнопок и старое содержимое.

WordPress славится своей расширяемостью. Это обеспечивает мехнанизм хуков, которые придуманы едва ли не на все возможные случаи. Полный список состоит из более, чем 1700, для версии движка 4.1, штук. Для написания плагинов знать всё не нужно. Официальной документации, обычно, хватает.

Продвинутая реализация плагина

Lite-версия получилась элементарной, верно? Не успели начать, а уже всё оказалось готово. Кто-то даже загорелся, что так же просто можно добавить код Google Adsense. Не буду разочаровывать — конечно же можно!

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

1. выводить кнопки до и после поста;
2. предоставлять интерфейс настройки размера кнопок (большие или маленькие) и выбора сервисов, интересных веб-мастеру;
3. добавлять удобную ссылку «Настройка» в списке плагинов, чтобы хозяин блога мог сразу перейти к управлению внешним видом вывода;
4. подчищать за собой данные при удалении.

<?php
/*
Plugin Name: YandexShare
Plugin URI: https://a-panov.ru/plagin-dlya-wordpress/
Description: Добавление кнопок «поделиться» разных социальных сетей
Version: 1.0
Author: Andi Panov <a@a-panov.ru>
Author URI: https://a-panov.ru/
License: GPLv2
*/

// подключим фильтр, срабатывающий перед выводом содержимого страницы (поста)
add_filter( 'the_content', 'yandexshare_run' );

// функция добавляет кнопки расшаривания перед и после поста
function yandexshare_run($content) {
    // получить сервисы для иконок
    $sharebtn = get_option('yandexshare_bnts');
    
    // если ни одного сервиса не выбрано, будем использовать только основные
    if ( !$sharebtn ) $sharebtn = 'vkontakte,odnoklassniki,facebook,twitter,gplus';
    
    // показывать ли большие иконки
    $bigbtn = get_option('yandexshare_bigbtn');
    
    // непосредственно код Яндекс Share. Детали — https://tech.yandex.ru/share/
    // необходимые скрипты
    $script = '
        <script type="text/javascript" src="//yastatic.net/es5-shims/0.0.2/es5-shims.min.js" charset="utf-8"></script>
        <script type="text/javascript" src="//yastatic.net/share2/share.js" charset="utf-8"></script>';
    // здесь учитываем желаемые иконки и их размер
    $data = '<div class="ya-share2" data-services="' . $sharebtn . '"' . ($bigbtn ? '' : ' data-size="s"') . '></div>';
    
    // вывод данных: подключение скриптов единожды, блок кнопок до статьи,
    // статья и ещё один аналогичный блок кнопок
    return $script . $data . $content . $data;
}

// добавим пункт в основное админ-меню WP
add_action('admin_menu', 'yandexshare_admin_menu');
function yandexshare_admin_menu(){
    add_options_page('YandexShare', 'Настройки YandexShare', 'manage_options', 'yandexshare-options', 'yandexshare_admin_manage');
}

// «морда» для управления настройками
function yandexshare_admin_manage() {
    // какие иконки соцсетей доступны
    $share_bnt_list = array(
        'vkontakte'     => 'ВКонтакте',
        'facebook'      => 'Facebook',
        'odnoklassniki' => 'Одноклассники',
        'moimir'        => 'МойМир',
        'gplus'         => 'Google+',
        'twitter'       => 'Twitter',
        'blogger'       => 'Blogger',
        'linkedin'      => 'LinkedIn',
        'lj'            => 'Livejournal',
        'viber'         => 'Viber',
        'whatsapp'      => 'WhatsApp',
    );
    
    // POST-параметры передаются из нашей формы настроек
    if (isset($_POST['yandexshare_bigbtn'])) {
        // большая кнопка
        $bigbtn = empty($_POST['yandexshare_bigbtn']) ? 0 : 1;
        
        // если установлено — добавляем в опции, иначе — удаляем,
        // т. к. значение по умолчанию и так ноль
        if ($bigbtn) update_option('yandexshare_bigbtn', 1);
        else delete_option('yandexshare_bigbtn');
        
        // если массив требуемых кнопок установлен...
        if (isset($_POST['yandexshare_bnts']) && is_array($_POST['yandexshare_bnts'])) {
            // приводим его к ожидаемому формату
            $sharebtn =  $_POST['yandexshare_bnts']
                       ? implode(',', $_POST['yandexshare_bnts'])
                       : '';
        }
        
        // если сняты все отметки...
        if (empty($sharebtn)) {
            // удаляемся из настроек WP
            delete_option('yandexshare_bnts');
            // и оставляем значения по умолчанию
            $sharebtn = 'vkontakte,odnoklassniki,facebook,twitter,gplus';
        } else {
            // иначе — установим требуемые кнопки
            update_option('yandexshare_bnts', $sharebtn);
        }
        $success = true;
    } else {
        // получить содержимое наших опций
        $bigbtn = get_option('yandexshare_bigbtn');
        $sharebtn = get_option('yandexshare_bnts');
        
        // если ни одного сервиса не выбрано — выводим основные;
        // для деактивации плагина его нужно отключить!
        if ( !$sharebtn ) $sharebtn = 'vkontakte,odnoklassniki,facebook,twitter,gplus';
    }
    $sharebtn_list = explode(',', $sharebtn);
?>
<div class="wrap">
    <h2>Настройки YandexShare</h2>
    <?php if ( isset($success) ) {
        echo '<div class="updated"><p>Настройки успешно сохранены.</p></div>';
    } ?>
    <form action="" method="post">
      <table class="table">
        <tbody>
          <tr>
            <th>Использовать большие кнопки</th>
            <td>
              <select name="yandexshare_bigbtn">
                <option value="0">Нет</option>
                <option<?= $bigbtn ? ' selected="selected"' : '' ?> value="1">Да</option>
              </select>
            </td>
          </tr>
          
          <tr>
            <th>Какие сервисы использовать</th>
            <td>
              <select name="yandexshare_bnts[]" size="<?= count($share_bnt_list) ?>" multiple>
                <?php foreach ($share_bnt_list as $k => $v) {
                    echo '<option ' , in_array($k, $sharebtn_list) ? 'selected="selected" ' : '' , 'value="' . $k . '">' . $v . '</option>';
                } ?>
              </select>
              <p class="description">Убирать/отмечать произвольные сервисы можно с зажатой клавишей Ctrl</p>
            </td>
          </tr>
        </tbody>
      </table>
      <p class="submit"><input type="submit" value="Сохранить изменения" class="button button-primary"></p>
    </form>
</div>
<?php
}

// добавим ссылку на Настройки в списке плагинов
add_filter('plugin_action_links', 'yandexshare_links', 10, 2);

// подцепим ссылку на Настройки
function yandexshare_links($links, $file) {
    $plugin_file = basename(__FILE__);
    if ($file == $plugin_file) {
        $settings_link = '<a href="options-general.php?page=yandexshare-options">Настройки</a>';
        array_unshift($links, $settings_link);
    }
    return $links;
}

// если плагин удаляется, подчистим все следы деятельности
register_uninstall_hook(__FILE__, 'yandexshare_remove');

// функция для удаления устанавливаемых плагином опций
function yandexshare_remove(){
    delete_option('yandexshare_bnts');
    delete_option('yandexshare_bigbtn');
}

Кода стало гораздо больше, но логически за всё отвечают 4 блока.

Вывод кнопок

Код немного усложнился по сравнению с лайт-версией. Во-первых, мы учитываем размер кнопок и соцсети, в которых можно поделиться. Данные получаем из сохранённых настроек, либо определяем значения по умолчанию. Во-вторых, учитываем, что js-скрипты нужно подключать один раз.

Настройка функций плагина

Подключение настроек выполняется в 2 этапа. Сначала подцепляем экшен admin_menu, который вызывает функцию yandexshare_admin_menu. Данная функция определяет страницу с настройками. Ссылка появится в меню Настройка, под названием Настройки YandexShare, видна будет только администратору — опция manage_options. Идентификатором меню будет строка yandexshare-options, а за отображение страницы наших настроек отвечает функция yandexshare_admin_manage().

Комментарии помогут разобраться, что происходит в функции. Если возникнут какие-то вопросы, пишите их в комментариях, попробуем найти ответ.

Добавление ссылки настройки в списоке плагинов

Реализуется с помощью фильтра plugin_action_links. Функция-обработчик — yandexshare_links() — принимает список установленных ссылок и имя файла-плагина. Нам нужно узнать вызов «своего» плагина и добавить туда новый элемент.

Удаление сохранённых данных

С помощью функции register_uninstall_hook() можно указать свою функцию, которая будет вызвана при удалении плагина. Хорошо, если плагин подчищает за собой, не оставляя ненужных данных. У нас определяются две настройки: yandexshare_bigbtn для вывода маленьких кнопок и yandexshare_bnts, содержащая список сервисов.

В общем-то, на этом всё. Надеюсь, данных знаний достаточно для понимания основ. В дальнейшем, останется ставить задачу, искать описание соответствующих хуков и добавлять фильтры/экшны для работы с ними.

Успехов!

Поддержка сайта

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

днём интернета
шоколадкой для работы мозга
коробочкой ароматного чая для бодрости
продлением хостинга на +1 месяц

Автор публикации

2 070

не в сети 4 месяца

x64 (aka andi)

Комментарии: 2893Публикации: 405Регистрация: 02-04-2009

(5 голосов, в среднем: 5,00 из 5)

Загрузка...