Разработка плагинов для WordPress от теории к практике — урок 33

- Николаенко Максим · Опубликовано 21 августа, 2016 · Обновлено 27 августа, 2020

Для тех кто не знает что такое плагин объясню в трех словах. Плагин это ваш код который каким-то образом меняет работу CMS WordPress или дополняет ее новыми функциями. Плагины были придуманы для того чтобы разработчикам не приходилось менять ядро CMS WordPress и все обновления проходили без ошибок, сайт при этом оставался в целостности и сохранности, а функционал системы мог дополняться. Подробнее о том что такое плагины вы можете прочитать в Codex WordPress. Для ленивых даю ссылку где искать плагины WordPress.

Содержание скрыть

1 Этап первый «Планирование». Что ваш плагин будет делать и как его назвать?

2 Домашняя страница плагина

3 Приступаем к разработке первого плагина WordPress

4 Разберем построчно базовый код плагина.

4.1 Давайте немного поработаем мы и заставим наш плагин работать.

Многие при изучении того как разрабатывать плагины смотрят в код уже созданных плагинов WordPress, но в любом случаи легче, если кто-то в начале объяснит элементарные вещи. Если вы уже создали плагин, то вы всегда сможете его прорекламировать разместив бесплатную версию в репозитории WordPress, а когда плагин наберет популярность то можно сделать и PRO версию, которая будет более полной и полезной. Обычно PRO версии продают за небольшую сумму многим пользователям.

Этап первый «Планирование». Что ваш плагин будет делать и как его назвать?

Тут надо хорошенько подумать и возможно взять лист бумаги и расчертить схему работы плагина.

Подумайте какие настройки будут в панели администратора и какой будет результат на выходе. Еще из важного нужно понимать что плагин должен быть полезным, чтобы его скачивали. Важно для популярности плагина в интернете назвать его так, чтобы в названии встречалось ключевое слово или чтобы название отображало часть функциональности плагина. Вот несколько примеров хороших названий для плагинов All in one SEO pack, Yoast SEO, Rus to Lat.

Если в дальнейшем вы хотите разметить свой плагин в репозиторий https://wordpress.org/extend/plugins/, то необходимо создать в корне файл readme.txt.

Домашняя страница плагина

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

Приступаем к разработке первого плагина WordPress

В этом уроке и в последующих уроках мы будем рассматривать как разработать плагин для WordPress, начнем с самого начального уровня. Разработка плагина в WordPress дело не хитрое если вы знаете язык программирования PHP и API WordPress.

Для начала создания собственного планига необходимо в папке wp-content/plugins создать папку плагина. Мы с вами создадим простейший плагин для изменения стилей панели администратора в WordPress.

Создайте папку styling-admin-panel (wp-content/plugins/styling-admin-panel) и в ней создайте файл index.php. Так принято что главным файлом плагина должен быть файл index.php или файл с названием плагина, но так как название фигурирует в имени каталога где лежит наш плагин, то файл называем просто index.php.

Разработка плагинов для WordPress

Внутри файла необходимо создать правильный комментарий PHP который поймет WordPress. С помощью этого комментария вы сможете активировать созданный плагин в панели администратора. Добавьте код в файл index.php в таком виде в котором я вам даю.

<?php
/**
 * @package Styling admin panel
 * @version 1.0
 */
/*
Plugin Name: Styling admin panel
Plugin URI:  https://wp-admin.com.ua/hello-dolly/
Description: This is a simple plug-in to change your admin panel style.
Author: Nikolaenko Maksim
Version: 1.1
Author URI: https://wp-admin.com.ua/
*/



?>

<?php

/**

* @package Styling admin panel

* @version 1.0

Plugin Name: Styling admin panel

Plugin URI: https://wp-admin.com.ua/hello-dolly/

Description: This is a simple plug-in to change your admin panel style.

Author: Nikolaenko Maksim

Version: 1.1

Author URI: https://wp-admin.com.ua/

Порядок строк в данном комментарии не имеет большого значения. Введенные данные можно поменять на свои но для это необходимо понимать где и что находится.

Разберем построчно базовый код плагина.

В созданный комментарий можно добавить авторские права и лицензию на плагин. Обычно используют лицензию GPL или совместимую с GPL. Доработаем наш код и добавим описание лицензии.

Вот так выглядит стандартный комментарий для плагина вместе с лицензией.

<?php
/**
 * @package Styling admin panel
 * @version 1.0
 */
/*
Plugin Name: Styling admin panel
Plugin URI:  https://wp-admin.com.ua/hello-dolly/
Description: This is a simple plug-in to change your admin panel style.
Author: Nikolaenko Maksim
Version: 1.1
Author URI: https://wp-admin.com.ua/
*/

/*  Copyright 2016  Nikolaenko Maksim  (email: prografika.com.ua@gmail.com)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

?>

<?php

/**

* @package Styling admin panel

* @version 1.0

Plugin Name: Styling admin panel

Plugin URI: https://wp-admin.com.ua/hello-dolly/

Description: This is a simple plug-in to change your admin panel style.

Author: Nikolaenko Maksim

Version: 1.1

Author URI: https://wp-admin.com.ua/

This program is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

После проделаной работы мы можем активировать наш плагин.

Создание плагинов WordPress

Давайте немного поработаем мы и заставим наш плагин работать.

С помощью плагина подключим стили для панели администратора WordPress, Для этого вставьте следующий код в файл плагина.

function my_admin_head() {
        echo '<link rel="stylesheet" type="text/css" href="' .plugins_url('style.css', __FILE__). '">';
}

add_action('admin_head', 'my_admin_head');

function my_admin_head() {

echo '<link rel="stylesheet" type="text/css" href="' .plugins_url('style.css', __FILE__). '">';

}

add_action('admin_head', 'my_admin_head');

добавить стили в панель администратора WordPress

Далее в папке с плагином создайте файл style.css.

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

Добавим в созданный файл style.css стили:

#adminmenu, #adminmenu .wp-submenu, #adminmenuback, #adminmenuwrap { 
    background-color: #0b67c3 !important;
}

#adminmenu, #adminmenu .wp-submenu, #adminmenuback, #adminmenuwrap {

background-color: #0b67c3 !important;

}

Если вы все сделали правильно, то на вашем тестовом сайте изменится цвет панели администратора.

Меняем цвет меню панели администратора при помощи созданного плагина WordPress

Вот таким простым действием мы смогли изменить стандартный вид меню в панели администратора WordPress. Если у вас есть опыт верстки HTML и CSS, то вы сможете изменить стандартный вид панели до неузнаваемости.

Все что мы проделали это создали хук на стандартную функцию WordPress и немного изменили ее работу. О том что такое хуки (зацепки) вы узнаете из следующих выпусков курса. Я решил урок разбить на несколько, чтобы не было длинной простыни текста и дать небольшой пример работы с плагином.