Добавление кастомных хуков в WordPress: Custom Actions. Инициализационные хуки WordPress: преимущества и типичные ошибки

08.07.2019
Хуки являются очень полезными фишками в Wordpress. Они позволяют как бы «посадить» пользовательскую функцию «на крючок» функции существующей, разрешая тем самым изменять функциональность Wordpress без внесения изменений в файлы ядра движка. В этой статье мы представляем Вам 10 особенно полезных, готовых к использованию хуков для Wordpress, с примерами и пояснениями их исходников.ЧТО ТАКОЕ ХУК? Для достижения определенного эффекта нам нужно слегка изменить принцип работы Wordpress. Некоторые модификации необходимо внести в файлы, которые были названы разработчиками файлами ядра – они нужны для того, чтобы Wordpress работал должным образом.
Но изменение файлов ядра – плохая идея: это может создать брешь в системе безопасности блога. Также, все модификации исчезнут, как только Вы обновите движок до новой версии.
Однако, расширение функциональности все же необходимо. Для этого разработчиками был придуман Plugin API.
Хуки являются одним из главных блоков для построения плагинов. Почти каждый подключаемый плагин использует хуки для расширения функциональности Wordpress.КАК ИСПОЛЬЗОВАТЬ ХУКИ В ВАШЕМ БЛОГЕ Пока Вы не написали свой плагин, Вы должны записать хуки в файл functions.php . Этот файл находится в директории wp-content/themes/yourtheme (где /yourtheme – директория, в которой находится текущая тема).
Вот пример, который показывает, как подключить Вашу пользовательскую функцию к функции ядра движка:
  • add_action ( "publish_post" , "myCustomFunction" ) ;
  • В этом примере мы подключили пользовательскую функцию myCustomFunction() к функции ядра publish_post() . Функция myCustomFunction() будет выполняться при каждом выполнении функции publish_post() .
    Конечно, мы можем также удалить хук, используя функцию remove_action() :

  • remove_action ( "publish_post" , "myCustomFunction" ) ;
  • 1. ОТКЛЮЧАЕМ АВТОМАТИЧСКОЕ ФОРМАТИРОВАНИЕ В WORDPRESSПроблема. Вы, наверное, уже замечали, что типограф Wordpress по умолчанию превращает «прямые» кавычки в «кривые» и делает другие мелкие изменения в форматировании поста.
    Это хорошо, если блоггер размещает обычный контент (подразумеваются обычный текст и картинки). Но некоторые постят исходный код, чтобы потом его обсуждать, и они будут очень недовольны, когда из-за этих «кривых» кавычек интерпретатор иди компилятор выдадут им сообщения о синтаксических ошибках.Решение. Просто вставьте в файл functions.php нижеследующий код:
  • function my_formatter($content ) {
  • $new_content = "" ;
  • $pattern_full = "{(\.*?\)}is" ;
  • $pattern_contents = "{\(.*?)\}is" ;
  • $pieces = preg_split ($pattern_full , $content , - 1 , PREG_SPLIT_DELIM_CAPTURE) ;
  • foreach ($pieces as $piece ) {
  • if (preg_match ($pattern_contents , $piece , $matches ) ) {
  • $new_content .= $matches [ 1 ] ;
  • } else {
  • $new_content .= wptexturize(wpautop($piece ) ) ;
  • return $new_content ;
  • remove_filter("the_content" , "wpautop" ) ;
  • remove_filter("the_content" , "wptexturize" ) ;
  • add_filter("the_content" , "my_formatter" , 99 ) ;
  • После того, как Вы это сделали, можете использовать тэг для того, чтобы текст поста был не отформатирован автоматически:

    This text will not be automatically formatted.Объяснение кода. Первым делом, мы создаем функцию, которая, основываясь на регулярных выражениях, находит тэг в содержании Вашего поста.
    Далее, мы привязываем нашу функцию my_formatter() к функции the_content() , что означает выполнение нашей функции всякий раз, когда вызывается функция the_content() .
    Для того, чтобы отключить автоформатирование, мы использовали функцию remove_filter() .2. ОПРЕДЕЛЯЕМ БРАУЗЕР ПОСЕТИТЕЛЯ ПРИ ПОМОЩИ ХУКОВПроблема. Кросс-браузерная совместимость – это наиболее распространенная проблема в web-разработке. Вы сэкономите много нервов и времени, если сможете определить браузер пользователя, зашедшего на Ваш блог, а затем создав CSS-класс для тэга body под каждый из браузеров. Решение. Ничего сложного: просто вставьте нижеследующий код в файл functions.php , сохраните его – все готово!
  • add_filter("body_class" , "browser_body_class" ) ;
  • function browser_body_class($classes ) {
  • global $is_lynx , $is_gecko , $is_IE , $is_opera , $is_NS4 , $is_safari , $is_chrome , $is_iphone ;
  • if ($is_lynx ) $classes = "lynx" ;
  • elseif ($is_gecko ) $classes = "gecko" ;
  • elseif ($is_opera ) $classes = "opera" ;
  • elseif ($is_NS4 ) $classes = "ns4" ;
  • elseif ($is_safari ) $classes = "safari" ;
  • elseif ($is_chrome ) $classes = "chrome" ;
  • elseif ($is_IE ) $classes = "ie" ;
  • else $classes = "unknown" ;
  • if ($is_iphone ) $classes = "iphone" ;
  • return $classes ;
  • После того, как Вы сохраните файл, функция автоматически будет добавлять CSS-класс, соответствующий пользовательскому браузеру, для тэга body :

    Объяснение кода. Wordpress имеет глобальные переменные, которые возвращают true , если пользователь использует соответствующий браузер. Если пользователь использует браузер Google Chrome, то переменная $is_chrome примет значение true . Вот для чего мы и создаем функцию browser_body_class() . После этого мы присоединяем ее к Wordpress функции body_class() .3. ОПРЕДЕЛЕНИЕ ТЕКСТА ПО УМОЛЧАНИЮ В РЕДАКТОРЕ TinyMCEПроблема. Многие блоггеры почти всегда используют для своего блога один и тот же формат. Сообщения в моем блоге WpRecipes.com всегда отображаются одинаково: текст, код, еще немного текста.
    Можно сэкономить немало времени, если научить TinyMCE отображать какой-нибудь текст по умолчанию.Решение. Как всегда, решением является хук. Копируем код в файл functions.php и смотрим, как он работает.
  • add_filter("default_content" , "my_editor_content" ) ;
  • function my_editor_content( $content ) {
  • $content = "If you enjoyed this post, make sure to subscribe to my rss feed." ;
  • return $content ;
  • Объяснение кода. Этот код хоть и простой, но очень мощный. Просто создаем функцию, которая возвращает требуемый текст (в этом примере мы определяем текст, который спрашивает у посетителей о подписке на RSS-ленту), и присоединяем ее к Wordpress-функции default_content() . Вот так.4. ВСТАВЛЯЕМ КОНТЕНТ АВТОМАТИЧЕСКИ ПОСЛЕ КАЖДОГО ПОСТАПроблема. В большинстве блогов для вывода контента после каждого поста файл single.php , но вот беда: этот контент не будет отображаться в RSS-ленте. Хуки помогут исправить эту проблему.Решение. Все то же самое – просто копируем следующий код в файл fucntions.php .
  • function insertFootNote($content ) {
  • $content .= "" ;
  • $content .= "Enjoyed this article?" ;
  • $content .= "

    Subscribe to our RSS feed and never miss a recipe!

    " ;
  • $content .= "" ;
  • return $content ;
  • add_filter ("the_content" , "insertFootNote" ) ;
  • Объяснение кода. Суть функции insertFootNote() проста: он лишь конкатенирует желаемый текст к переменной $content , в которой хранится содержание поста.
    Затем, мы присоединяем нашу функцию insertFootNote() к функции the_content() .
    Видите в строке 2 вот такой код:
  • if (! is_feed() && ! is_home() ) {
  • Если Вам нужно, чтобы текст попадал в RSS-ленту, то замените предыдущий код на этот:

  • if (! is_home() ) {
  • Вот и все.

    5. ОТКЛЮЧАЕМ СООБЩЕНИЕ С ПРОСЬБОЙ ОБНОВИТЬСЯ В ПАНЕЛИ УПРАВЛЕНИЯ WORDPRESSПроблема. Вы можете видеть информацию о наличии новой версии Wordpress вверху дашборда. Это действительно хорошая штука, так как обновление закрывает дыры в безопасности и позволяет пользоваться Вам последними возможностями движка. Но если блог не Ваш лично, а является проектом для кого-нибудь из клиентов, то давать возможность клиентам самим обновляться – не есть хорошая идея.Решение. Просто вставьте следующий код в файл fucntions.php .
  • if (! current_user_can("edit_users" ) ) {
  • add_action( "init" , create_function ( "$a" , "remove_action("init", "wp_version_check");" ) , 2 ) ;
  • add_filter( "pre_option_update_core" , create_function ( "$a" , "return null;" ) ) ;
  • После того, как Вы сохраните файл functions.php , сообщения Вы больше не увидите.

    Объяснение кода. Для начала, убедимся, что текущий пользователь обладает достаточными правами администратора, чтобы можно было обновить Wordpress. Как только мы в этом убедились, создаем пару хуков, которые переписывают правила отображения сообщений в дашборде.6. ОТКЛЮЧАЕМ АВТОСОХРАНЕНИЕ ПОСТОВПроблема. Wordpress периодически сохраняет пост по мере его введения. Это полезная возможность, но иногда она не требуется.Решение. Для того, чтобы отключить автосохранение поста, просто откройте файл functions.php и вставьте в него следующий код.
  • function disableAutoSave() {
  • wp_deregister_script("autosave" ) ;
  • add_action( "wp_print_scripts" , "disableAutoSave" ) ;
  • Объяснение кода. И вновь, ничего сложного: мы просто создаем функцию, которая отключается автосохранение и привязываем ее к Wordpress-функции wp_print_scripts() .7. ИЗБАВЛЯЕМСЯ ОТ ПОВТОРЯЮЩЕГОСЯ КОНТЕНТА НА СТРАНИЦАХ С КОММЕНТАРИЯМИПроблема. Повторяющийся контент эта довольно распространенная SEO-проблема.
    Введенная в Wordpress версии 2.7 система разбиения комментариев на страницы эту проблему не решает.
    Для предупреждения повторяющегося контента в комментариях будем использовать атрибут rel=«canonical» .Решение. Копируем следующий код и вставляем его в файл functions.php .
  • function canonical_for_comments() {
  • global $cpage , $post ;
  • if ( $cpage > 1 ) :
  • echo "\n " ;
  • echo "
  • echo get_permalink( $post -> ID ) ;
  • echo "" />\n " ;
  • endif ;
  • add_action( "wp_head" , "canonical_for_comments" ) ;
  • Объяснение кода. Сначала, мы создаем функцию, которая добавляет к каждой странице с комментариями, кроме первой, тэг link с атрибутом rel=«canonical» . Затем, присоединяем эту функцию к Wordpress-функци wp_head() .8. ПОЛУЧЕНИЕ ПОСТА ИЛИ СТРАНИЦЫ В КАЧЕСТВЕ PHP-ПЕРЕМЕННОЙПроблема. Возможность получить текущий пост или целую страницу в качестве PHP переменной – действительно крутая вещь. Скажем, Вы можете заменять некоторые части контента при помощи функции str_replace() или делать с ним еще что-нибудь.Решение. И снова ничего сложного. Делаем все то же самое: вставляем следующий код в файл functions.php .
  • function callback($buffer ) {
  • // modify buffer here, and then return the updated code
  • return $buffer ;
  • function buffer_start() {
  • ob_start ("callback" ) ;
  • function buffer_end() {
  • ob_end_flush () ;
  • add_action("wp_head" , "buffer_start" ) ;
  • add_action("wp_footer" , "buffer_end" ) ;
  • Объяснение кода. Для того, чтобы этот хак работал, необходимы три функции:
    • callback() : эта функция возвращает страницу целиком как переменную $buffer . Вы можете модифицировать ее как угодно, например, при помощи регулярных выражений;
    • buffer_start() : эта функция начинает буферизацию. Ее мы присоединяем к функции wp_head() ;
    • buffer_end() : эта функция очищает буфер. Ее мы присоединяем к функции wp_footer() .
    9. ИСПОЛЬЗУЕМ ХУКИ И CRON ДЛЯ СОБЫТИЙ ПО РАСПИСАНИЮПроблема. Вы, наверное, уже знаете, что Wordpress может использовать события по расписанию. К примеру, можно публиковать посты в конкретное, установленное заранее, время. Используя хуки и wp-cron , мы можем запросто задать расписание для нашего собственного события. В следующем примере мы заставим блог отправлять нам сообщения на e-mail один раз каждый час.Решение. Вставляем следующий код в файл functions.php .
  • if (! wp_next_scheduled("my_task_hook" ) ) {
  • wp_schedule_event( time () , "hourly" , "my_task_hook" ) ;
  • add_action( "my_task_hook" , "my_task_function" ) ;
  • function my_task_function() {
  • wp_mail("[email protected]" , "Automatic email" , "Hello, this is an automatically scheduled email from WordPress." ) ;
  • Объяснение кода. Первое, что мы сделаем, конечно, - это создадим функцию, которая будет выполнять требуемое действие. В этом примере эта функция называется my_task_function() и она просто отправляет письмо на указанный e-mail адрес.
    Для того, чтобы запланировать выполнение этой функции, мы будем использовать функцию wp_schedule_event() . Последним аргументом, передаваемым ей, будет наш хук, поэтому мы «цепляем» нашу функцию my_task_function() к my_task_hook .10. СПИСОК ВСЕХ «ХУКНУТЫХ» ФУНКЦИЙПроблема. Когда что-то идет не так, здорово может пригодиться список всех «хукнутых» функций.Решение. Как и все предыдущие фрагменты кода следующий также необходимо вставить в файл functions.php . Только не забудьте удалить его после использования. Если Вы этого не сделаете, то сообщения будут появляться и после отладки.
  • function list_hooked_functions($tag = false ) {
  • global $wp_filter ;
  • if ($tag ) {
  • $hook [ $tag ] = $wp_filter [ $tag ] ;
  • if (! is_array ($hook [ $tag ] ) ) {
  • trigger_error ("Nothing found for "$tag " hook" , E_USER_WARNING ) ;
  • return ;
  • else {
  • $hook = $wp_filter ;
  • ksort ($hook ) ;
  • echo "" ;
  • foreach ($hook as $tag => $priority ) {
  • echo "
    >>>>>\t $tag
    " ;
  • ksort ($priority ) ;
  • foreach ($priority as $priority => $function ) {
  • echo $priority ;
  • foreach ($function as $name => $properties ) echo "\t $name
    " ;
  • echo "" ;
  • return ;
  • После того, как Вы вставите этот код в файл functions.php , вызовите функцию list_hooked_functions() . Она и покажет Вам список всех «хукнутых» функций.

    Объяснение кода. Данный код выясняет, передается ли имя хука в качестве аргумента функции. Если передается, то на экран выводится имя хука. Также можно посмотреть хуки только для определенной функции:

    Одним из краеугольных камней выполнения задач в WordPress является понимание принципов работы хуков (зацепок). Само по себе это не сложно, а в этой статье мы постараемся ознакомить вас с основами.

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

    Мы расскажем вам о системе хуков WordPress и их использовании, а также рассмотрим хуки действия и фильтров.

    Перед тем, как начать, убедитесь, что вы имеете всё необходимое для работы, и у вас установлена последняя версия WordPress.

    Что такое хуки?

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

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

    Архитектура, управляемая событиями (англ. event-driven architecture, EDA) является шаблоном архитектуры программного обеспечения, позволяющим создание, определение, потребление и реакцию на события.

    Если вы только начали работать с шаблонами проектов или разработкой, то это может показаться вам сложным, но лучше воспринимать это так:

    • Программное обеспечение в определенные моменты может присылать вам сообщение о каком-то событии.
    • Мы, как разработчики, способны написать код, который отслеживает эти сообщения, а потом отвечает на них пользовательским кодом.

    Обратите внимание, что в определении речь идёт и о создании событий. Когда мы будем обсуждать наши собственные хуки, то вернёмся к этой теме. А теперь давайте рассмотрим два события, распространённых в веб-разработке.

    Использование JavaScript

    Представьте, что вы работаете в сфере фронтенд разработки. У вас есть кнопка с ID атрибутом command-button , и когда пользователь нажимает на неё, то должно открыться диалоговое окно.

    С помощью jQuery вы можете реализовать этот функционал вот так:

    (function($) { "use strict"; // jQuery"s DOM-ready event-handler $(function() { /** * Listen for the "click" event on the button identified * with the "command-button" ID attribute. * * When the user clicks on it, display an alert dialog. */ $("#command-button").bind("click", function(evt) { alert("You clicked the button."); }); }); })(jQuery);

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

    Конечно, другие библиотеки, платформы или vanilla JavaScript предлагают тот же самый набор функций. Причиной, почему мы рассказываем о jQuery, является то, что это одна из самых распространённых библиотек JavaScript, и потому что она связана с WordPress.

    Использование WordPress

    Применение этого шаблона разнится в зависимости от языка программирования или парадигмы. Это часто зависит от API, который предоставляет платформа или приложение.

    В WordPress регистрация собственного кода, запускающего события, немного отличается. К примеру, давайте представим, что вы работаете с административной страницей в WordPress и хотите добавить новый элемент подменю в меню Настройки . Назовём его Tuts+ Options .

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