Каждый знакомый с WordPress слышал про файл темы (шаблона) functions.php . Однако не все хорошо понимают его назначение, видя в нем лишь файл в котором хранятся различные php функции. В сети, как и у меня на этом сайте, часто предлагается добавлять PHP код в этот файл. Однако не каждый код подойдет для этого файла. Не потому что он не будет работать, а потому что он не подходит по логике использования.

Также при редактировании functions.php новички допускают ошибки из-за которых сайт перестает работать.

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

Возможности functions.php

functions.php располагается в папке темы и загружается каждый раз, во время просмотра внешней части сайта, в админ-панели и даже во время AJAX запросов. Нет случая, когда functions.php не будет подключен и это открывает широкие возможности перед разработчиками.

Для примера, следующий код, вставленный в файл темы functions.php расширит возможности темы - включит поддержку миниатюр поста:

Add_action("after_setup_theme", "wp_kama_theme_setup"); function wp_kama_theme_setup(){ // Поддержка миниатюр add_theme_support("post-thumbnails"); }

Другой пример, код заменит текст в подвале админ-панели WordPress, на данные о количестве запросов к базе данных, времени генерации страницы и использовании памяти:

## Данные о количестве запросов к базе данных в подвале админки add_filter("admin_footer_text", "wp_usage"); // в админке add_filter("wp_footer", "wp_usage"); // на сайте function wp_usage(){ echo sprintf(__("SQL: %d за %s сек. %s MB", "km"), get_num_queries(), timer_stop(0, 3), round(memory_get_peak_usage()/1024/1024, 2)); }

functions.php против плагинов

- «Плагины работают медленнее чем код в файле functions.php», говорят неосведомленные - это не так!

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

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

Поэтому, давайте удалим его из functions.php и сделаем из него плагин - это просто!

Чтобы создать плагин нужно создать файл с кодом ниже (название файла может быть любое), добавить его в каталог плагинов wp-content/plugins/ и активировать плагин в админ-панели:

Если нет желания видеть еще один плагин в админ-панели, то можно использовать Must-Use плагины .

Для чего на самом деле нужен functions.php

Как я писал выше: functions.php необходим для того, чтобы расширить функциональность темы и только для этого! В этот файл нужно добавлять всякий код, который нужен для шаблона непосредственно, но не для сайта в целом.

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

Как подгружается functions.php

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

Index.php wp-blog-header.php wp-load.php wp-config.php wp-settings.php // Подключаются самые базовые функции (подключение к БД $wpdb и система фильтров) // Подключаются базовые фильтры // SHORTINIT: Остановка загрузки, где есть только самое базовое: if (SHORTINIT) return false; // подключается вся среда WordPress: базовые функции, фильтры // подключаются must-use плагины, затем срабатывает событие: do_action("muplugins_loaded"); // подключаются активированные плагины, затем срабатывает событие: do_action("plugins_loaded"); // устанавливаются глобальные переменные: wp_the_query, wp_query, wp_rewrite, wp, wp_widget_factory, wp_roles ... do_action("setup_theme"); // устанавливается текущая тема // подключается файл темы >>>>>>>>>>>> functions.php <<<<<<<<<<<< do_action("after_setup_theme"); // событие, когда среда WP, все плагины и тема полностью подключены, но на экран еще ничего не выведено: do_action("init"); // проверка статуса сайта для мультисайтовой сборки // тоже самое что init только после проверки статуса (до этой строки работа PHP может не дойти) do_action("wp_loaded"); wp() // заполняет основной запрос WP и все глобальные переменные связанные с ним wp-includes/template-loader.php // подключает нужный файл шаблона

Процесс загрузки WordPress, и functions.php в частности, хорошо показан на этом рисунке:

Схема загрузки WordPress

Ошибки в functions.php при вставке кода

Неоднократно встречал вопросы об ошибках, вроде: "После установки кода в файл functions.php сайт перестал работать - белый экран. Что делать?". Я и сам с подобным сталкивался когда-то.

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

Вставляете готовый код - сайт перестает работать.

1. Редактируете functions.php - сайт перестает работать.

Чаще всего, дело в открывающем и закрывающем тегах PHP . Обычно, если вставляемый код имеет в начале и в конце эти теги, то их нужно удалить. Также, файл functions.php не должен выводить на экран никакой текст (HTML код или другой контент). Вывод текста допускается только внутри функции, которые в дальнейшем будут использоваться в шаблоне или которые прикрепляются к хукам (подробнее см. ниже).

Нельзя допускать никаких символов до , в том числе невидимые символы (перенос строки), потому что functions.php подключается до установки http заголовков (в таких заголовках передаются различные данные, например, что это html документ; что кодировка utf-8 другое). По правилам PHP, контент должен выводится на экран после того, как отправлены заголовки. А все что за пределами это и есть контент - текст выводимый на экран, даже невидимый символ \n. Поэтому такой текст вызывает ошибку.

Чтобы не было ошибок, учитывайте 4 момента:

#1 Правильная вложенность

Пример, у нас была такая структура:

........здесь код......... ?>

Правильно так:

#2 Никаких переносов строк, пробелов, текста до

Такой код вызовет ошибку:

А этот нет:

Логичнее его записать так:

Бывает что перенос строки ставят в самом конце functions.php, вот тогда это становится настоящей проблемой, потому что все казалось бы правильно, но сайт не работает. На самом деле после?> или до

здесь пустая строчка

По этой причине многие разработчики вообще удаляют закрывающий тег?> , это допустимо для PHP. Рекомендую всегда делать именно так:

#3 Использование внутри PHP функции

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

Дело в том, что в этом случае функция только лишь регистрируется и не выполняет никаких действий. Все что внутри функции (между { }) не работает пока эта функция не будет вызвана, а вызываются такие функции обычно из шаблона или через фильтры, уже после того как отправлены HTTP заголовки. Поэтому в данном примере, мы можем игнорировать переносы строк и использовать?> и

#4 Кодировка

Еще одна заметка касательно файла functions.php: устанавливайте файлу кодировку UTF-8 (UTF-8 без BOM). Иначе, если функции в файле будет текст на кириллице, то он выведется непонятными символами: кракозябрами, каракулями - называйте как хотите.

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

Давайте будем честны, ведь вы хоть раз делали это, не так ли? И это понятно, ведь на форуме так и было написано - добавьте этот код в functions.php вашей темы на WordPress.

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

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

Что такое functions.php

Если вы когда либо лазили по файлам вашего WordPress сайта, вы могли наткнуться на несколько файлов functions.php. Файл functions.php, о котором мы будем говорить в этом уроке, находится в папке: wp-contentthemesваша_темаfunctions.php.

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

Почему всегда использовать functions.php - это плохая идея

Не поймите неправильно, использовать functions.php для маленьких кусочков кода в пару строк - это вполне нормальная ситуация. Мы говорим о том, что нежелательно использовать functions.php как склад для абсолютно всего добавленного вами кода. Это не универсальное решение для любой ситуации.

Причина №1.

Если выйдет обновление для вашей темы оформления, вы потеряете всё, что вы дописали в файле functions.php. Я знаю, о чем вы только что подумали - но ведь есть как раз для таких ситуаций?

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

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

Причина №2.

Даже если вы правильно настроили и используете дочернюю тему. Что случится, если вы захотите перейти на другую тему оформления? Я надеюсь, вы добавили комментарий к каждому внесенному изменению в вашем файле functions.php, потому как без этого переход на другую тему будет крайне болезненным. Думаю, вы уловили мысль.

Причина №3.

Если вы добавили код в functions.php, который совершенно неожиданным образом полностью сломал ваш сайт, и вы видите пустой белый экран - вам понадобится FTP клиент, чтобы закачать "испорченный" functions.php, отредактировать его и загрузить обратно на сайт. Удовольствие такое себе.

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

Правильное использование functions.php для дочерней темы, активной в данный момент - это допустимый вариант. Но помните, я акцентировал внимание на этом слове "активной "?

Если вы добавляете порции кода, которые будут иметь смысл только в работе с конкретно этой темой, тогда вы можете смело использовать functions.php (в дочерней теме). Вот несколько примеров, когда это будет уместно:

• Добавление еще одного файла стилей (.css) для вашей темы
• Изменение длины для анонса записи (post excerpt), чтобы сайт выглядел лучше
• Добавление кастомных шрифтов для текущей темы
• Добавление файла локализации для перевода текущей темы

Другими словами, каждый раз при добавлении или изменении чего-либо, связанного с конкретной текущей темой, вы можете смело использовать functions.php.

Когда лучше обойтись без functions.php

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

Вот пару примеров, когда лучше обойтись без functions.php:

• Создание кастомных виджетов, которые вы будете часто использовать
• Создание кастомных шорткодов
• Добавление кода, который не зависит от темы оформления (код Google Analytics и т.д.)

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

Вы сейчас подумали - ломать голову над созданием плагина, когда можно отредактировать functions.php? Это слишком сложно! Поверьте, это не так. Это делается очень легко и быстро.

Как настроить кастомный плагин вместо functions.php

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

1. Создать текстовый файл с вашим кодом и сохранить его как.php файл
2. Запаковать полученный.php файл в.zip архив
3. Установить этот архив как обычный WordPress плагин в меню Плагины → Добавить новый

Вот и все, всего 3 действия.

Шаг 1. Создание.php файла с вашим кодом

Откройте Блокнот на вашем компьютере и вставьте следующий текст:

Конечно, вы можете использовать свое имя для плагина в строке Plugin Name:

Сохраните файл и дайте ему какое-то уникальное имя, чтобы WordPress не перепутал ваш плагин с уже установленными. Например: wpcafe-custom-functions.php.

Да, не забудьте при сохранении выбрать тип файлов "Все файлы" и дописать расширение.php:

Шаг 2. Создайте.zip архив

Думаю, тут не нужно никаких пояснений. Просто создайте.zip архив с вашим файлом любым удобным архиватором.

Шаг 3. Установите как обычный плагин

Самая простая часть. Просто зайдите в админке WordPress в Плагины → Добавить новый и загрузите ваш архив как самый обычный плагин.

Как только вы активируете его, вы сможете увидеть свой новый плагин в списке всех других установленных плагинов:

Как добавлять свой код

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

Например, вот так будет выглядеть ваш файл.php, если вы захотите сделать шорткод "Hello World!":

Эти комментарии никак не влияют на работоспособность вашего кода и на скорость выполнения плагина. Но с ними вам будет проще ориентироваться и помнить, что делает каждая функция, которую вы добавили.

Просто оберните свой комментарий в синтаксис из косой и звездочки: /* Ваш комментарий */

После внесения изменений в ваш код вы можете перезагрузить.php файл через FTP или просто создать новый.zip архив и загрузить как новый плагин, а старый удалить.

Другие способы как избегать правок functions.php

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

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

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

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

Итоги

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

Так что, этот метод действительно заслуживает внимания.

В этом руководстве мы подробно рассмотрим как создать плагин 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 , удаления не произойдёт, поскольку страница уже будет сгенерирована.

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

"; } // Определение функции "mfp_Remove_Text()" удаление нашей предыдущей функции из события "wp_footer" function mfp_Remove_Text() { if (date("l") === "Monday") { // Target the "wp_footer" action, remove the "mfp_Add_Text" function from it remove_action("wp_footer", "mfp_Add_Text"); } } ?>

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

Функции фильтры позволяют изменять возвращаемые другими функциями данные и должны быть прежде перехвачены при помощи хуков-фильтров . Хуки-фильтры несколько отличаются от хуков-событий. Однако, работают они подобно хукам-событиям – могут быть вызваны в разных точках скрипта и контекстно. Полный список хуков-фильтров и контекста вызова можно найти на 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-код, как показано ниже и загрузите файл.

При создании админ страниц, WordPress рекомендует заключать свой HTML в теги div и давать ему имя класса “wrap”, как показано выше. Это гарантирует, что весь ваш контент появится в правильном месте и будет выглядеть также как и другие админ страницы. Если не придерживаться этой рекомендации, страница может выглядеть не очень привлекательно.

Вернитесь к списку плагинов WordPress в Админ Консоли и активируйте его. Как только страница загрузится, посмотрите вниз мену навигации админ панели. Здесь вы увидите новую ссылку с именем ‘My First Plugin’. Нажмите на неё и вы увидите свою родную страницу админ управления!

Заключение

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

8 ответов

Вы можете использовать шаблон Observer. Простой функциональный способ выполнить это:

Вывод:

This is my CRAZY application 4 + 5 = 9 4 * 5 = 20

Примечания:

В этом примере исходного кода вы должны объявить все свои плагины перед фактическим исходным кодом, который вы хотите продлить. Я включил пример того, как обрабатывать одно или несколько значений, передаваемых плагину. Самая сложная часть этого заключается в написании фактической документации, в которой перечислены, какие аргументы передаются каждому крюку.

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

Извините, похоже, символы подчеркивания заменяются объектами HTML Markdown? Я могу повторно опубликовать этот код, когда эта ошибка будет исправлена.

Edit: Nevermind, он появляется только тогда, когда вы редактируете

Итак, скажем, вам не нужен шаблон Observer, потому что он требует, чтобы вы изменили методы класса для обработки задачи прослушивания и хотите получить что-то общее. И скажем, вы не хотите использовать наследование extends , потому что вы уже можете наследовать свой класс из какого-то другого класса. Было бы здорово иметь общий способ сделать любой класс подключаемым без особых усилий? Вот как:

_Class = get_class(&$RefObject); $this->_RefObject = $RefObject; } public function __set($sProperty,$mixed) { $sPlugin = $this->_Class . "_" . $sProperty . "_setEvent"; if (is_callable($sPlugin)) { $mixed = call_user_func_array($sPlugin, $mixed); } $this->_RefObject->$sProperty = $mixed; } public function __get($sProperty) { $asItems = (array) $this->_RefObject; $mixed = $asItems[$sProperty]; $sPlugin = $this->_Class . "_" . $sProperty . "_getEvent"; if (is_callable($sPlugin)) { $mixed = call_user_func_array($sPlugin, $mixed); } return $mixed; } public function __call($sMethod,$mixed) { $sPlugin = $this->_Class . "_" . $sMethod . "_beforeEvent"; if (is_callable($sPlugin)) { $mixed = call_user_func_array($sPlugin, $mixed); } if ($mixed != "BLOCK_EVENT") { call_user_func_array(array(&$this->_RefObject, $sMethod), $mixed); $sPlugin = $this->_Class . "_" . $sMethod . "_afterEvent"; if (is_callable($sPlugin)) { call_user_func_array($sPlugin, $mixed); } } } } //end class Plugin class Pluggable extends Plugin { } //end class Pluggable //////////////////// // PART 2 //////////////////// class Dog { public $Name = ""; public function bark(&$sHow) { echo "$sHow
\n"; } public function sayName() { echo "
\nMy Name is: " . $this->Name . "
\n"; } } //end class Dog $Dog = new Dog(); //////////////////// // PART 3 //////////////////// $PDog = new Pluggable($Dog); function Dog_bark_beforeEvent(&$mixed) { $mixed = "Woof"; // Override saying "meow" with "Woof" //$mixed = "BLOCK_EVENT"; // if you want to block the event return $mixed; } function Dog_bark_afterEvent(&$mixed) { echo $mixed; // show the override } function Dog_Name_setEvent(&$mixed) { $mixed = "Coco"; // override "Fido" with "Coco" return $mixed; } function Dog_Name_getEvent(&$mixed) { $mixed = "Different"; // override "Coco" with "Different" return $mixed; } //////////////////// // PART 4 //////////////////// $PDog->Name = "Fido"; $PDog->Bark("meow"); $PDog->SayName(); echo "My New Name is: " . $PDog->Name;

В первой части, что вы можете включить с вызовом require_once() в верхней части вашего PHP скрипт. Он загружает классы, чтобы сделать что-то подключаемое.

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

В части 3, где мы переключим наш класс на "подключаемый" (т.е. поддерживаем плагины, которые позволяют нам переопределять методы и свойства класса). Так, например, если у вас есть веб-приложение, у вас может быть реестр плагинов, и вы можете активировать плагины здесь. Обратите внимание также на функцию Dog_bark_beforeEvent() . Если я установил $mixed = "BLOCK_EVENT" перед оператором return, он заблокирует собаку от лая и также заблокирует Dog_bark_afterEvent, потому что не будет никакого события.

В части 4, что нормальный код операции, но обратите внимание, что то, что вы могли бы подумать, будет работать не так. Например, собака не объявляет его именем "Fido", но "Coco". Собака не говорит "мяу", но "Уоф". И когда вы захотите посмотреть имя собаки потом, вы обнаружите, что это "Разное", а не "Коко". Все эти переопределения были представлены в части 3.

Итак, как это работает? Ну, пусть исключают eval() (которые все говорят "злые") и исключают, что это не шаблон Observer. Таким образом, способ, которым это работает, - это скрытый пустой класс под названием Pluggable, который не содержит методов и свойств, используемых классом Dog. Таким образом, поскольку это происходит, магические методы будут задействованы для нас. Поэтому в частях 3 и 4 мы связываемся с объектом, полученным из класса Pluggable, а не с самим классом Dog. Вместо этого мы позволяем классу Plugin "касаться" объекта Dog для нас. (Если это какой-то дизайн, о котором я не знаю - сообщите мне.)

Метод крюка и слушателя является наиболее часто используемым, но есть и другие вещи, которые вы можете сделать. В зависимости от размера вашего приложения и того, кто хочет увидеть код (это будет FOSS script, или что-то в доме), сильно повлияет на то, как вы хотите разрешить плагины.

kdeloach имеет приятный пример, но его реализация и функция hook немного небезопасны. Я бы попросил вас дать больше информации о характере приложения php для вашего письма, и о том, как вы видите плагины.

1 к kdeloach от меня.

Вот подход, который я использовал, это попытка скопировать из механизма Qt сигналов/слотов, своего рода шаблон Observer. Объекты могут излучать сигналы. Каждый сигнал имеет идентификатор в системе - он состоит из идентификатора id + объекта-отправителя Каждый сигнал может быть привязан к приемникам, который просто является "вызываемым", Вы используете класс шины для передачи сигналов любому, кто заинтересован в их получении Когда что-то происходит, вы посылаете сигнал. Ниже приведен пример и пример реализации

login(); ?>

Я считаю, что самый простой способ - следовать советам Джеффа и взглянуть на существующий код. Попробуйте посмотреть на Wordpress, Drupal, Joomla и другие известные PHP-CMS, чтобы посмотреть, как выглядят и ощущаются их API-интерфейсы. Таким образом, вы даже можете получить идеи, о которых вы, возможно, раньше не думали, чтобы сделать вещи немного более густыми.

Более прямой ответ заключался бы в том, чтобы написать общие файлы, которые они бы включили в include файл, чтобы обеспечить удобство использования. Это будет разбито на категории и НЕ предоставлено в одном файле "hooks.php" MASSIVE. Будьте осторожны, потому что то, что заканчивается, заключается в том, что файлы, которые они включают, в конечном итоге имеют все больше и больше зависимостей и функциональности. Попытайтесь ограничить зависимость API. I.E меньше файлов для их включения.