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

Внимание! Данная статья создана для того, чтобы помочь с созданием собственных плагинов для своего сайта, о создании плагинов для репозитория WordPress следует обратиться к руководству разработчика плагинов WordPress. которое покрывает все аспекты создания плагинов, отправки их в репозиторий и дальнейшей поддержки, оно постоянно дополняется и является наиболее актуальным, английский язык вам понадобится в любом случае, поэтому, если вы создаете плагин для репозитория WordPress, то вам стоит перейти туда.

Для чего вам следует создавать собственный плагин для сайта?

Многие владельцы/администраторы сайтов часто сталкиваются с необходимостью использования собственного PHP кода на сайте, если для CSS можно использовать Консоль — Внешний вид — дополнительные стили, для вставки HTML-кода в содержимое страницы (в том числе и заголовков HTTP) есть отличные плагины, например https://ru.wordpress.org/plugins/dco-insert-analytics-code/, то для PHP обычно приходится использовать или имеющиеся плагины в репозитории, либо, часто используют functions.php темы оформления.

Примечание: Для создания шорткодов со своим PHP-кодом можно использовать https://ru.wordpress.org/plugins/shortcoder/

Этот подход имеет ряд существенных недостатков:

  • Потеря кода при обновлении темы
  • Необходимость создания дочерней темы (см. предыдущий пункт)
  • Плохая организация кода, в functions.php будет как ваш код, так и код темы
  • Легко забыть что и зачем вы вносили в functions.php
  • Код работает только в текущей (измененной) теме и вам придется переносить код в другую тему при необходимости
  • Нельзя просто взять и отключить код без редактирования functions.php

При использовании плагина:

  • Вы размещаете код в одном месте, его легко найти, про него сложно забыть
  • Код легко включить через активацию плагина и также легко выключить, деактивировав его
  • Код будет работать с любой темой оформления

Наверх ↑

Создать свой плагин легко!

Создание плагина для WordPress включает в себя несколько шагов. В первую очередь, создаётся папка плагина, которая хранится в папке всех плагинов WordPress (обычно это /wp-content/plugins/).
Для удобства лучше выбрать имя плагина типа AAA_example.com (где example.com — адрес вашего сайта, а начиная названия с AAA_ ваш плагин оказывается в начале списка плагинов сайта). Не стоит выбирать название плагина, если таковой уже существует в репозитории, могут быть конфликты и неожиданное обновление вашего плагина на плагин из репозитория. Таким образом папка плагина будет называться (к примеру) /wp-content/plugins/aaa_example.com/

Затем создаётся главный файл плагина, название которого должно совпадать с названием папки плагина. Главный файл плагина начинается с заголовка PHP-комментария, в котором указывается имя плагина.

<?php

/**
 * Plugin Name: Название плагина
 * Description: Краткое описание плагина (140 символов)
 * Author:      Имя автора
 * Version:     Версия плагина, например 1.0
 * License:     GPL2
 * Network:     Укажите "true" для возможности активировать плагин для сети Multisite.
 */

// далее следует код вашего плагина

По завершении создания плагина для начала использования нужно его активировать. Это можно сделать в меню «Плагины» в консоли WordPress.