Это главный файл в вашей теме WordPress. Располагается в /wp-content/themes/{тут название вашей темы}/functions.php .
В нём определяются важные свойства темы, кастомизируются хуки, внешний вид и её функциональность, а также добавляются некоторые необходимые вам функции. Этот файл загружается каждый раз при открытии любой страницы WordPress, поэтому с его помощью можно изменить любой элемент сайта. В связи с этим, многие советы а-ля «как изменить что-то в WordPress без плагинов » часто касаются именно внесения изменений в functions.php, вместо того, чтобы создать под этот функционал отдельный плагин или воспользоваться готовым решением. Зачастую это приводит к информационной перегрузке этого файла, код становится тяжело разобрать, а внести исправления ещё сложнее. Но не это самое опасное. Самое опасное — это то, что при смене активной темы пропадёт часть или весь необходимый функционал сайта .

Чем отличается functions.php от плагина

Ничем. По своей сути, functions.php и есть эдакий глобальный неотключаемый плагин, который привязан к текущей теме. Как он подключается в WordPress, можно посмотреть в wp-settings.php . Как видно из исходного кода, его загрузка происходит после всех плагинов, однако, это не даёт никаких недостатков или преимуществ, разве что возможность переопределить что-то в подключенных плагинах. На скорость исполнения кода это также никак не повлияет. Влияет только содержание плагинов и functions.php. Поэтому, будьте внимательны при выборе активных плагинов для своей темы и откажитесь от ненужных, малополезных вам, тогда вы сможете облегчить ваш сайт и ускорить его работу.

Когда нужно использовать functions.php

Руководствуйтесь следующим правилом: если функционал напрямую связан с текущей темой, но не с работой сайта, записывайте его в functions.php.

К примеру, это может быть

• Настройка миниатюр
• Установка размеров сайдбаров
• Настройка мест под виджеты
• Объявление мест под навигационное меню
• Настройки темы
• Дополнительные функции вашей темы

Когда стоит избегать использования functions.php

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

• Определение счётчиков посещаемости (Google Analytiсs, Yandex.Metrika, Liveinternet)
• Настройка дополнительного функционала админки (например, )
• Конфигурирование исходного кода ()
• Определение шорткодов
• Регистрация

Списки неполные, вы можете определить их содержание сами под себя.

Куда внести данный код, если не в functions.php? Вы можете написать специальные плагины под них, однако, есть способ интереснее и проще.

mu-plugins как альтернатива functions.php

К нам в современные версии WordPress из WordPress MU(Multi-User) пришёл интересный функционал, называемый MU Plugins . Суть его заключалась в следующем. Администратору WordPress MU порой требовалось определить плагины для всей сети сайтов. Обычным функционалом этого было не добиться, поэтому ввели специальный раздел: /wp-content/mu-plugins/ , где они и определялись. Ещё что интересно, файлы плагинов из этой директории загружаются раньше всех остальных, что даёт возможность предопределить некоторые константы или настройки.
Позже WPMU упразднили, его код интегрировали с основным блоговым, и теперь любой WordPress может использовать функционал MU-plugins, который теперь расшифровывается как Must Use , то есть обязательный к использованию.

Как использовать mu-plugins

Вначале нужно создать специальный раздел /wp-content/mu-plugins/
В него мы помещаем нужные файлы-плагины. В отличие от обычных плагинов, здесь не нужно выдерживать специальный синтаксис, а функционал можно объявлять напрямую

Здесь для примера создан файл с кодом счётчиков посещаемости.
Внутри этот файл выглядит вот так

// ... Вместо этой строки вставляем код счётчиков...

В админке он будет выглядеть как Необходимые

7-мая версия PHP увидела свет в недавнем 2015 году. Новый виток в развитии этого языка программирования принес много возможностей для всех тех, кто использует PHP . Среди преимуществ новой версии следует выделить скорость. Так, по данным разработчиков, скорость работы скриптов на PHP 7 , по сравнению с предыдущими версиями, возросла почти в два раза. В связи с этим, многие владельцы сайтов, на которых установлены более старые версии PHP , хотят перейти на новую.

Зачем проверять на совместимость?

Следует отметить, что перед тем, как в панели управления Вашего хостинга менять версию PHP на более новую и быструю, необходимо проверить сайт WordPress на совместимость с ней, а именно темы и плагины. Такая необходимость возникает из-за того, что обычно в новых версиях программного обеспечения какие-то функции добавляются, а некоторые вообще перестают существовать. Если в каком-то плагине или теме используется несуществующие в новой версии функции или методы, то это привет к ошибке, что может нарушить работу сайта в целом.

Как проверить на совместимость с PHP 7.0?

Плагин PHP Compatibility Checker

Плагин PHP Compatibility Checker позволяет просканировать весь сайт и указать, какие из его компонентов (темы, плагины) не совместимы с выбранной версией PHP . Для начала необходимо его установить и активировать, после чего в админ-панели перейти Инструменты -> PHP Compatibility .

Как видим, плагин предлагает весьма понятные настройки. Для начала проверки необходимо выбрать версию PHP , на совместимость с которой хотите проверить сайт (блок PHP Version ). Удобной функцией плагина является выбор статуса проверяемых компонентов. Доступны на выбор два варианта: либо проверять среди активных тем и плагинов, либо в неактивных (поле Plugin / Theme Status ). Для старта проверки нужно нажать кнопку Scan site again .

Результат проверки также можно загрузить в текстовом файле, нажав для этого кнопку Download Report .

Если вы хотите, чтобы ваш блог, чтобы нормально функционировать, идеально было бы рассмотреть вопрос об изменении или обновлении версии PHP. Новая версия PHP (PHP7) еще не является достаточно распространенным явлением, но это не задерживает, потому что эта новая версия приносит много нового и вполне вероятно, что эта версия требуется для всех хостинг WordPress.

Почему вы должны сделать обновление до PHP 7

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

Вот некоторые из наиболее распространенных причин, почему вы должны вы должны рассмотреть возможность сделать обновить PHP версии:

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

Все это веские причины, но, прежде чем идти вперед и обновить PHP, есть и минусы для обновления вы должны рассмотреть и прочитать его внимательно.

Также будут рассмотрены важные побочные эффекты...

Если вы хотите переключиться, все не обязательно розовые, к сожалению.

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

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

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

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

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

Проверка совместимости PHP

Вот несколько плагинов, которые можно использовать, чтобы проверить совместимость среды с обновленной версией PHP:

• Проверка совместимости PHP - Этот плагин позволяет вам определить версию PHP и провести анализ по сравнению с текущей версией PHP на вашем хостинге. Он также создает отчет, чтобы рассказать вам, что исправить.
• Ник PHP Compiler - Инструмент проверки PHP для проверки неопределенных функций и методов.
• Error Log Monitor - Если есть ошибки, вы можете активировать журнал, чтобы отслеживать все ошибки, что поможет вам облегчить их устранение.

Вы также можете включить частный журнал ошибок вручную, используя " WP_DEBUG ». Вы также можете увидеть, что изменилось для каждой версии PHP до обновления:

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

Как изменить PHP версии

Резервное копирование версии выполняется автоматически при изменении версии.

Это все, что вы можете сделать, чтобы обновить окружающую среду. Если у вас есть вопросы, не стесняйтесь оставить комментарий.

Я относительно часто публикую различные , которые сильно упрощают жизнь. И почти всегда я акцентирую внимание на том, как правильно их подключить.

Конечно, проще и привычнее пойти традиционным путем и тупо вставить сниппет в файл functions.php вашей активной темы. Но в 9 из 10 случаев будет целесообразнее и правильнее вынести код сниппета в отдельный плагин . В крайнем случае, добавить его в специальный функциональный плагин вашего сайта. Т.н. Site-Specific WordPress Plugin , в котором-то и будет храниться весь дополнительный функционал вашего сайта.

Зачем это нужно

Поясню на простом примере. Допустим, вы разработали сайт со сложной структурой, массой кастомных типов данных, таксономий, фильтров, меню, с поддержкой огромного количества произвольных полей и пользовательских настроек. Всю кастомизацию, как и подобает в таком случае, вы разместили в файле functions.php . Все хорошо, но пройдет какое-то время, и перед вами встанет задача редизайна. Вы захотите сменить или разработать новую тему. Тогда-то и начнутся проблемы. Потому что весь функционал сайта, интегрированный в старую тему, отключится вместе с ней.

Как же быть

Нужно понять простую истину. В файле функций темы должны располагаться только функции, относящиеся к дизайну вашего сайта. Конкретно к той теме, файл функций которой редактируется. А вся т.н. «механика», рабочий функционал сайта и все его кастомизации правильнее размещать в плагинах. Или в одном плагине. Тогда при смене темы, он останется нетронутым.

Создаем специальный плагин функций WordPress

На самом деле, все делается очень просто.

• В директории плагинов вашего WordPress создаете папку. Например: /wp-content/plugins/mysite-plugin/ ;
• Создаете в этой папке файл, назвав его, к примеру, my-plugin.php ;
• Вставляете в этот файл примерно такой код:
• Переходите в настройки управления плагинами и активизируете свой новый плагин.

Заголовок, описание и комментарии к коду можно заменить на свои. Теперь все необходимые сниппеты и кастомизацию вы можете размещать в этом плагине. Не боясь потерять функционал сайта при очередной смене активной темы.

На этом можно и остановиться, но с моей стороны было бы не совсем правильно не упомянуть про т.н. MU-плагины .

MU-плагины (Must Use Plugins)

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

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

Преимущества MU-плагинов

• MU-плагины не нужно активировать, они всегда активны, их невозможно отключить в консоли управления сайтом;
• MU-плагин подключается и активируется банальной закачкой файла плагина в директорию mu-plugins;
• MU-плагины загружаются в алфавитном порядке перед загрузкой обычных плагинов.

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

В заключение

Как видите, ничего принципиально сложного в использовании функциональных плагинов нет. А преимущества их использования налицо. Мне не раз приходилось слышать такое мнение, что плагины создают на сайт какую-то неимоверную нагрузку. У многих пользователей существуют некие предубеждения о вреде использования плагинов. Это не совсем верно. Вред могут нанести левые, неизвестно кем разработанные и неизвестно откуда скачанные плагины. Плохая оптимизация работы плагина, использование устаревших функций PHP и WordPress. Вред может быть от большого количества одновременно работающих плагинов. Особенно с дублирующим функционалом. Возможен и банальный конфликт плагинов, плагинов с темой. А при грамотном и разумном подходе, плагины принесут вашему сайту исключительно пользу .

Всё самое новое и интересное из мира Вордпресс в моём Телеграм-канале . Подписываемся!

В этом руководстве мы подробно рассмотрим как создать плагин WordPress со своей собственной страницей администрирования. Характерная особенность любого плагина – это отделение своего кода от кода ядра WordPress. Если с плагином что-то произойдёт, остальная часть сайта будет работать.

• Текстовый редактор

Для выполнения шагов этого руководства вам понадобиться текстовый редактор, например, Notepad++ или среда разработки NetBeans . Также вам нужен доступ по FTP в вашей учётной записи на хостинге и .

Данное плагин WordPress руководство написано для тех, кто уже имеет . По руководству мы создадим новую функцию, вызовем существующие функции WordPress, используя их как параметры.

Что такое плагин WordPress?

Плагин WordPress – это автономный код, который улучшает и расширяет функциональность WordPress. Используя любую комбинацию PHP, HTML, CSS, JavaScript/jQuery или ряда других языков программирования, плагин WordPress может добавить новые характеристики к любой части вашего сайта, включая Консоль Администрирования. Вы можете изменять поведение WordPress по умолчанию или полностью удалять ненужное поведение. Плагины позволяют легко настраивать WordPress под себя и свои потребности.

Поскольку плагин WordPress это отдельный код, он не пересекается непосредственно с какой либо частью кода ядра WordPress. Плагин может быть скопирован или установлен на любую установку WordPress. Альтернативный (и очень не рекомендуемый) путь внесения изменений в WordPress – написание новой функции в файл WordPress functions.php , который находится в каталоге /wp-includes/ или в файл functions.php , который является частью вашей темы. Это может привести к ряду возможных проблем.

WordPress и его темы регулярно обновляются. И пока вы используете дочернюю тему WordPress , очередное обновление будет перезаписывать файл functions.php , а добавленный вами новый код будет удален и придётся его добавлять снова и снова. Ещё один неудобный момент может возникнуть, если вы напишете много функций и в одной из них будет ошибка, которую вы никак не может отследить, вам может потребоваться заменить текущий файл оригинальным, однако при этом придётся пожертвовать всеми остальными функциями. Это повлечёт за собой большое количество PHP-ошибок на сайте, потому как вызовы уже удалённых функций ещё будут осуществляться из других мест.

Плагины же никогда автоматически не перезаписываются и не удаляются при обновлении WordPress. Если в коде вашего плагина WordPress есть ошибки, вы можете просто отключить его в Админ Консоли на время исправления ошибки. В случае, если в вашем плагине серьёзная ошибка, WordPress иногда может самостоятельно автоматически отключить его, чтобы сохранить функционирование всего сайта.

Что такое хук (hook)?

Плагины WordPress взаимодействуют с кодом ядра через так называемые хуки (hooks , от англ. hook – крючок). К ним, как к крючкам можно “цеплять” выполнение каких-либо интересных нам функций. В WordPress есть два вида хуков:

1. Action hooks или хуки-события (добавить/удалить пользовательскую функцию к некоторому событию).
2. Filter hooks или хуки-фильтры (для изменения данных, обрабатываемых функциями).

События и Хуки-события

Посещение любой страницы WordPress-сайта – это вызов множества функций PHP (называемых событиями – actions ). Функции привязываются к хукам-событиям (action hooks) . Механизм хуков-событий предоставляется WordPress. Вы можете добавлять свои функции к какому-либо событию из списка событий, используя механизм хуков и они будут запускаться по запуску этого события. Вы также можете удалять уже существующие функции из любого списка хуков-событий. Хуки-события привязаны к выполнению определённого события. Например, перед закрытием тега на любой странице, вызывается хук-событие wp_head() и запускается ряд функций, которые привязаны к этому хуку wp_head() .

Добавление функций на хук события, используя add_action()

Чтобы добавить функцию на любой хук-событие, ваш плагин WordPress должен вызвать функцию WordPress под названием add_action() , как минимум с двумя параметрами.

// Хук события "init", вызывается после того, как WordPress завершает загрузку кода ядра add_action("init", "add_Cookie"); // Установка cookie с текущим временем дня function add_Cookie() { setcookie("last_visit_time", date("r"), time()+60*60*24*30, "/"); }

• хука-события (action hook) , к которому собираемся связать свою функцию.
• Второй обязательный параметр – имя функции (function) , которую будем запускать.
• приоритет (priority) функции, которую вы собираетесь запустить. Вы можете привязать сколько угодно функций к одном хуку события и обращаться к ним в любом порядке. Приоритет запуска по умолчанию – 10, ваша функция запускается сразу после встроенных функций WordPress. Функция с приоритетом 11 запустится следующей и так далее.
• количество аргументов , означает сколько параметров ваша пользовательская функция может принять. По умолчанию количество параметров равно 1.

Пример кода плагина для отображения текста после раздела футера (footer) на каждой странице

Этот плагин WordPress перехватывает хук-событие wp_footer() , который вызывается сразу перед закрытием тега на каждой странице и добавляет новую функцию под названием mfp_Add_Text() . Так как плагин WordPress не привязывается к теме, то функционал будет работать даже при смене темы на другую. Можете сохранить себе этот пример в файл PHP, загрузить его в каталог wp-content/plugins/ и активировать в Админ Консоли, чтобы увидеть изменения.

Вот результат:

Примечание: PHP загружает содержимое сразу всего скрипта перед его выполнением, это значит, что вы можете вызвать add_action() перед определением вашей функции: вызвать add_action() с вашими функциями вначале файла в том порядке, в котором они будут загружаться, потом определить ваши функции в таком же порядке ниже. Такое структурирование кода сделает файл более лёгким для чтения.

Удаление функций из хуков-событий, используя remove_action()

Для удаления функции, связанной с хуком-событием, нужно воспользоваться remove_action() . Пример ниже поможет понять принцип работы добавления и удаления функций в/из хука событий.

// Хук на событие "init", который вызывается после завершения загрузки ядра WordPress и функция "remove_My_Meta_Tags" add_action("init", "remove_My_Meta_Tags"); // Удаляем функцию "add_My_Meta_Tags" из хука-события wp_head function remove_My_Meta_Tags() { remove_action("wp_head", "add_My_Meta_Tags"); }

Запускается remove_action() как минимум в двумя параметрами.

• Первый обязательный параметр – название хука-события (action hook) , к которому функция была прикреплена
• Второй обязательный параметр – это имя функции (function) , которую вы хотите удалить
• Третий (необязательный) параметр – это приоритет удаляемой функции. Этот параметр должен совпадать с тем приоритетом, который был задан при добавлении события к хуку событий. Если он не был определён, не включайте этот параметр.

Пример: представим, что вы хотите, чтобы текст, добавленный в футере в предыдущем примере, не выводился по понедельникам. Один из путей реализации этого, использовать функцию даты в PHP, чтобы получить текущий день недели, проходя условным оператором if…then… и проверяя соответствует ли текущий день понедельнику, затем вызвать remove_action(), если это понедельник. Вызываем функцию проверки и удаления по дню недели при помощи add_action() , прикрепляясь к событию, происходящему раньше (например, wp_head ), чем то, к которому прикреплено наше основное действие выведения текста в футере (wp_footer) . Если мы выберем событие происходящее позже, чем wp_footer , удаления не произойдёт, поскольку страница уже будет сгенерирована.

После загрузки футера сайта добавляется мой текст!

Фильтры и хуки-фильтры

Функции фильтры позволяют изменять возвращаемые другими функциями данные и должны быть прежде перехвачены при помощи хуков-фильтров . Хуки-фильтры несколько отличаются от хуков-событий. Однако, работают они подобно хукам-событиям – могут быть вызваны в разных точках скрипта и контекстно. Полный список хуков-фильтров и контекста вызова можно найти на WordPress Plugin API/Filter Reference page.

Добавление фильтров, используя add_filter()

Чтобы добавить любую функцию к хуку-фильтру, ваш плагин должен вызвать функцию WordPress под названием add_filter() , с как минимум двумя параметрами.

// Перехват хука-фильтра "the_content" (содержимое любого поста), запуск функции "mfp_Fix_Text_Spacing" add_filter("the_content", "mfp_Fix_Text_Spacing"); // Автоматическое исправление двойного пробела function mfp_Fix_Text_Spacing($the_Post) { $the_New_Post = str_replace(" ", " ", $the_Post); return $the_New_Post; }

• Первый обязательный параметр – это название хук-фильтра (filter hook) , на который хотим повесить функцию.
• Второй параметр – это имя функции фильтра (filter function), которую хотим запустить.
• Третий параметр (необязательный) – это приоритет (priority) функции, которую вы хотите запустить. В хуку-фильтру можно добавить сколько угодно разных фильтров функций. Приоритет по умолчанию – 10, устанавливает очередь вашей пользовательской функции после любой встроенной функции. Функция с приоритетом 11 запустится следующей и так далее.
• Четвёртый параметр (необязательный) – это количество аргументов , который означает сколько параметров ваша пользовательская функция может принять. По умолчанию количество параметров равно 1.

Пример. Плагин WordPress для изменения фрагмента/выдержки записи

В WordPress есть функция, которая извлекает отрывок (цитату) из записи, называется она get_the_excerpt() , и также является хуком-фильтром. Функция, отображающая отрывок, вызывает get_the_excerpt(), чтоб его получить, это то место, где применяется фильтр и отрывок изменяется до отображения. Этот плагин WordPress определяет функцию фильтр, которая берёт отрывок текста как входной параметр, добавляет некоторый текст вначале него и возвращает новое значение каждый раз, когда вызывается get_the_excerpt() . Так как возвращаемое функцией get_the_excerpt() значение – это фактический фрагмент текста, он автоматически вводится как параметр функции $old_Excerpt, когда вызывается, используя add_filter(). Функция, которую вы определяете должна вернуть новое значение .

Excerpt: " . $old_Excerpt; return $new_Excerpt; } ?>

Итоговый результат:


Удаление фильтров, используя remove_filter()

Для удаления фильтра нужно просто вызвать функцию remove_filter() . Например, добавим снова простое условие и будем удалять текст, если сегодня четверг.

// Хук-фильтр get_the_excerpt, запуск функции mfp_Add_Text_To_Excerpt add_filter("get_the_excerpt", "mfp_Add_Text_To_Excerpt"); // Если сегодня четверг, удалить фильтр the_excerpt() if (date("l") === "Thursday") { remove_filter("get_the_excerpt", "mfp_Add_Text_To_Excerpt"); } // Взять отрывок, добавить текст и вернуть новый отрывок function mfp_Add_Text_To_Excerpt($old_Excerpt) { $new_Excerpt = "Excerpt: " . $old_Excerpt; return $new_Excerpt; }

Теперь, когда уже есть базовое представление о хуках фильтрах и событиях, создадим простой плагин WordPress, который добавляет новую ссылку и страницу в Админ Консоль.

Шаг 1 – Сохранение плагина

Первым шагом в создании плагина для WordPress является создания каталога для хранения всех файлов. Все плагины хранятся в каталоге: /wp-content/plugins/ . Каталог, который вы создаёте должен иметь уникальное и понятное название, не пересекающееся с другими плагинами. Поключитесь к своему аккаунту на хостинге по FTP . Из основного каталога WordPress перейдите в wp-content потом в plugins . Внутри каталога plugins создайте новый каталог с названием my-first-plugin .


Отдельные файлы с кодом плагина лучше тематически разделять по подкаталогам внутри основного каталога плагина вместо того, чтобы хранить всё в одном каталоге, это позволит не путаться и будет хорошим смысловым разделением исходных файлов плагина. Особенно разделение файлов по смыслу будет хорошо ощутимо, когда ваш плагин будет разрастаться и становиться более сложным. Если ваш плагин использует свои стили CSS создайте каталог CSS и сохраните туда все файлы CSS. Если ваш плагин WordPress использует JavaScript создайте каталог JavaScript .

Шаг 2 – Создание первого файла

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

В вашем каталоге my-first-plugin создайте новый PHP-файл и назовите его my-first-plugin.php . Хорошей практикой является название основного файла плагина также как и каталога. Добавьте открывающий тег PHP в первой строке. Вам не обязательно добавлять закрывающий тег в конце файла (чтобы понять почему, почитайте примечание на странице PHP мануала). Этот файл будет содержать прежде всего так называемые ‘header comments’ или заголовочные комментарии с информацией, которая будет прочитана и отображена WordPress. Header comments заключается в многострочный комментарий PHP, в каждой строке определяется специальная информация, начинающаяся со специальных символов, чтобы можно было определить, к чему эта строка относится. Такая структура должна присутствовать только в первом файле и её не нужно повторять в остальных.

Первой строкой в комментарии в файле my-first-plugin.php нужно добавить имя плагина. Начинайте многострочный комментарий PHP открывая его символами /* во второй строке файла, сразу после тега открытия PHP. В третьей строке напишите Plugin Name: My First Plugin. В двух следующих отдельных строкахможно указать описание плагина и имя автора.Затем, со следующей строки закрываем блок комментариев символами */ . Ваш файл теперь выглядит примерно так:

Имя автора .

Шаг 3 – Написание функций плагина

Как уже было сказано выше, хорошей практикой является разделение кода плагина в соответствующие файлы и каталоги. Так как основная функция первого файла в том, чтобы содержать в себе информацию о плагине, то сам плагин WordPress разместим в других файлах и каталогах и воспользуемся функцией PHP ‘include’ для доступа к ним. Любые файлы, хранящиеся в подкаталогах вызываются прямо из нашего кода и только из нашего кода, поэтому имя подкаталога не нуждается в префиксе. Однако, весьма рекомендуем применять уникальный префикс для ваших файлов, функций и переменных, чтобы избежать конфликтов с другими плагинами. В связи в этим мы будем использовать префикс mfp , сокращение от ‘My First Plugin’.

В главном каталоге вашего плагина создайте новый подкаталог с названием includes. Любой файл, который будет подключатся по ‘include’ в другом файле будет идти в этот подкаталог. Создайте новый файл PHP в подкаталоге includes и сохраните его как mfp-functions.php. Открываем тег в первой строке. В этом новом файле будут храниться функции вашего плагина.

Теперь вернитесь к my-first-plugin.php в основном каталоге плагина. Нам нужно подключить файл mfp-functions.php , для того чтобы использовать новые функции. Так как это главный файл плагина, подключение mfp-functions.php здесь сделает функции доступными в любом другом файле вашего плагина. Используйте require_once , чтобы один раз подключить файл с функциями и чтобы быть уверенным, что плагин работает только, если функции доступны. Самый простой путь подключения файлов из вашего каталога плагинов – это использование функции WordPress plugin_dir_path(__FILE__) , которая выдаёт полный путь к директории, где наш плагин WordPress хранится, потом использовать . (period), чтобы дополнить именем подкаталога, который мы создали раньше (includes ), затем имя созданного нами файла (mfp-functions.php ).

Редактируем my-first-plugin.php как показано ниже, потом сохраняем и загружаем ещё раз, перезаписывая предыдущую версию.

Вернёмся к mfp-functions.php в подкаталоге includes .

Хорошая идея объединить несколько функций вместе и написать многострочный комментарий над каждой группой, описывая группу, затем короткий однострочный комментарий перед каждой из функций с её описанием. Таким образом вам не придётся читать весь код в поисках функции и распознаванию, что она делает. Назовём функцию mfp_Add_My_Admin_Link(). Она будет добавлять новую верхнюю ссылку в Админ Консоли в меню навигации.

Резюмируя, пишем новую функцию следуя этим шагам:

• Пишем комментарии, описывающие функцию
• Называем функцию
• Пишем функцию

В mfp-functions.php, пишем следующее:

Внутри нашей функции нам нужно использовать встроенную функцию WordPress add_menu_page() , чтобы задать имя меню, заголовок и определить, кто может её видеть. Затем мы говорим, что отображать, когда мы переходим на страницу. Вы можете также добавить к ссылке в меню иконку и установить её позицию в меню навигации админ панели – и то и другое по желанию, поэтому в нашем руководстве мы на этом не будем останавливаться. Рядом со ссылкой на вашу страницу будет отображаться иконка по умолчанию. Наша ссылка появится внизу меню навигации админ консоли. Вся эта информация вводится как параметры в add_menu_page() .

Четыре необходимых параметра add_menu_page() – каждый с новой строки для лучшей наглядности:

1. Название страницы, которую вы увидите после нажатия на ссылку (отображается во вкладке браузера).
2. Текст, отображаемый в ссылке меню (отображается в списке навигации Админ Консоли), это может быть название вашего плагина.
3. Требования к возможностям пользователя видеть меню, в этом примере только пользователи с возможностью ‘manage_options’ могут иметь доступ к странице (об этой сейчас не беспокойтесь).
4. Какой файл использовать, когда открывать страницу (мы создадим его за следующим шагом), который будет храниться в подкаталоге includes и называться mfp-first-acp-page.php. URL введённый здесь известен как ‘slug’.

Прежде чем мы продолжим, важно знать, что есть альтернативный путь использования этой функции. Четвертый параметр может быть просто строкой текста, которая отображается в ссылке url после ‘wp-admin/admin.php?page=’ . Если вы введёте ‘my-plugin-page’, URL станет ‘wp-admin/admin.php?page=my-plugin-page’ . Четвёртый параметр тогда должен быть именем функции, которая выводит что-либо. Вы можете написать функцию, которая лишь выводить ‘Welcome to page 1’, например. Значительно проще создать PHP файл, который будет содержать вашу страницу.

Редактируем mfp-functions.php, удаляем // My code goes here, заменяем его на add_menu_page() и передаём параметры, как показано ниже:

Чтобы запустить эту функцию нам нужно использовать функцию WordPress под названием add_action() с двумя параметрами, как описано в разделе ‘Добавление функций на хук-событие’ этого руководства. Вы можете перечитать этот раздел перед тем, как продолжить.

• Первый параметр – action hook, который вы хотите отловить. В нашем случае хук события это admin_menu – это значит, наша функция загружается тогда, когда Админ меню начинает генерироваться.
• Второй параметр – просто имя запускаемой функции. Функция, которую мы написали называется mfp_Add_My_Admin_Link . Обратите внимание, что круглые скобки здесь не пишутся. Помните, что PHP загружает весь скрипт до его запуска, позволяя вам использовать add_action() раньше определения функции, указанной в параметре 2.

Наш окончательный файл выглядит так:

Загрузите файл mfp-functions.php в каталог includes и перезапишите старый.

Шаг 4 – Создание новой админ-страницы

Теперь можно создать страницу, которая будет отображаться при нажатии на ссылку в вашей админ консоли. Вернитесь в подкаталог includes и создайте новый файл PHP с названием mfp-first-acp-page.php. Открывающий тег PHP не обязателен в этом файле, поскольку мы будем использовать только HTML. Напишите HTML-код, как показано ниже и загрузите файл.