Плагин WordPress — это один файл и две функции
Содержание
Люди боятся писать плагины для WordPress, потому что те, что они видят в каталоге, занимают тысячи строк. Механизм под ними крошечный. Плагин — это PHP-файл с комментарием в начале, и всё, что он делает, он делает, прося WordPress вызвать ваши функции в именованные моменты. Вот он целиком, собранный из ничего.
Заголовок
Создайте каталог wp-content/plugins/hello-tags/, а в нём файл hello-tags.php. WordPress узнаёт плагин по блоку комментария в начале этого файла и ни по чему другому:
Сохраните его — и он уже появится в разделе Plugins панели администратора, готовый к активации. Пока он ничего не делает. Проверка ABSPATH не даёт файлу ничего делать, если кто-то запросит его напрямую из веба, а не через WordPress.
Действия: сделать что-то в определённый момент
Строя страницу, WordPress проходит длинную последовательность именованных моментов, и add_action привязывает вашу функцию к одному из них. Чтобы добавить строку в подвал каждой страницы:
Первый аргумент — имя момента, второй — ваша функция. wp_footer срабатывает там, где тема вызывает wp_footer(), что всякая приличная тема делает прямо перед </body>. Другие моменты, которыми вы будете пользоваться постоянно: init (WordPress загружен, ничего ещё не выведено), wp_enqueue_scripts (правильное место для добавления таблиц стилей и скриптов), admin_menu (добавить страницу настроек).
Фильтры: изменить что-то по пути
add_filter — та же идея, только ваша функция получает значение, изменяет его и обязана его вернуть. Чтобы добавить метки записи в конец тела каждой записи:
Забыть return — классическая ошибка в фильтрах: тело записи молча исчезает. Имена фильтров, которые вам будут встречаться чаще всего: the_content, the_title, the_excerpt и wp_title.
Шорткод
Шорткод — это фильтр с более дружелюбным лицом. Он позволяет автору набрать в записи [hello_tags], а ваша функция это заменит:
shortcode_atts объединяет то, что набрал автор, например [hello_tags prefix="Filed under: "], с вашими значениями по умолчанию. Всегда экранируйте всё, что пришло от человека, прежде чем это печатать; esc_html — это минимум.
Активация и деактивация
Если плагину нужно что-то один раз настроить, зарегистрируйте хук активации. Здесь он сохраняет опцию по умолчанию, а при деактивации удаляет её:
Таблица опций — место, где живут настройки плагинов. get_option('hello_tags_enabled') прочитает значение где угодно.
Привычки, которые стоит завести с первой строки
- Добавляйте префикс к имени каждой функции и опции. Все плагины на сайте делят одно пространство имён PHP. Два плагина, каждый из которых определяет
footer(), роняют весь сайт фатальной ошибкой. - Внутри фильтра никогда не печатайте, всегда возвращайте. Печать из фильтра выводит текст в начало страницы, а не туда, где ему место.
- Экранируйте при выводе.
esc_html,esc_attr,esc_url. WordPress не сделает этого за вас. - Держите файл доступным веб-серверу только для чтения. Плагин, в который веб-сервер может писать, — это плагин, который может переписать атакующий. Я писал о том, как это выглядит на практике.
Вот и весь механизм. Каждый большой плагин, который вы когда-либо устанавливали, — это тот же шаблон, повторённый много раз: заголовок, функции, привязанные к моментам, значения, изменяемые по пути. Размер берётся от того, что плагин делает много вещей, а не от того, что какая-то из них трудна.