Как работают хуки wordpress

WordPress. Как работают хуки

В процессе загрузки WordPress происходит множество событий. К каждому из этих событий можно привязать функцию, которая выполнит какое-то действие ( action ) или изменит данные ( filter ). Разделение нужно, потому что по смыслу это разные вещи. Действие просто отрабытывает в нужный момент и ничего не возвращает, а фильтр — обрабатывает переданные данные и обязательно должен их вернуть.

Как работают хуки

Это упрощенный вариант реализации хуков, который наглядно показывает, как это работает:

$actions = array(); function add_action($hook, $function)  global $actions; if (!isset($actions[$hook]))  $actions[$hook] = array(); > $actions[$hook][] = $function; > function do_action($hook)  global $actions; if (isset($actions[$hook]))  foreach($actions[$hook] as $function)  call_user_func($function); > > >

Функция add_action() назначает обработчик $function для события $hook . Функция do_action() инициирует событие $hook , после чего вызываются на выполнение все функции-обработчики этого события.

Примеры хуков-действий

// создадим функцию для хука function echo_one()  echo 'one'; > // привяжем функцию к хуку add_action('some_hook', 'echo_one'); // выполним хук do_action('some_hook'); // выведет «one»

// создадим функции для событий function echo_one($data)  echo $data[0]; > function echo_two($data)  echo $data[1]; > // привяжем эти функции к хуку add_action('some_hook', 'echo_one'); add_action('some_hook', 'echo_two'); // выполним хук do_action('some_hook', array('Привет', ' мир!') ); // выведет «Привет мир!»

Функция add_action()

add_action($hook, $function, $priority, $count);

Прикрепляет указанную функцию на указанный хук. Функция $function сработает в момент события $hook , которое в свою очередь запускается с помощью do_action() .

Функция do_action()

do_action($hook, $arg1, $arg2, …);

Инициирует событие $hook , к которому могут быть прикреплены произвольные функции. Чтобы функция сработала в момент события, её нужно подключить к этому событию с помощью функции add_action() .

Примеры хуков-фильтров

// создадим функцию для хука function some_filter($str)  return 'Привет ' . $str . '!'; > // привяжем функцию к хуку add_filter('some_hook', 'some_filter'); // выполним хук $data = apply_filters('some_hook', 'мир'); // посмотрим, что получилось echo $data; // выведет «Привет мир!»

// создадим функцию для хука function crop_string($string)  return iconv_substr($string, 0, 6) . '…'; > // привяжем функции к хуку add_filter('prepare_string', 'strip_tags'); add_filter('prepare_string', 'crop_string'); // выполним хук $data = apply_filters('prepare_string', '
Привет, мир!
'); // посмотрим, что получилось echo $data; // выведет «Привет…»

Функция add_filter()

add_filter($hook, $function, $priority, $count);

Прикрепляет указанную функцию на указанный хук. Функция $function сработает в момент события $hook , которое в свою очередь запускается с помощью apply_filters() .

Функция apply_filters()

apply_filters($hook, $value, $arg1, $arg2, …);

Инициирует событие $hook , к которому могут быть прикреплены произвольные функции. Чтобы функция сработала в момент наступления события, её нужно подключить к этому событию с помощью функции add_filter() .

• WordPress. Порядок загрузки страницы
• WordPress. Создание одностраничного сайта
• WordPress. Обработка POST-запросов. Часть 1
• WordPress. Форма комментирования
• WordPress. Теги шаблона
• WordPress. Установка и использование WP-CLI
• WordPress. Обработка POST-запросов. Часть 2

Каталог оборудования

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Производители

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Функциональные группы

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Категории блога
Облако тегов

• 1С:Предприятие (31)
• API (29)
• Bash (43)
• CLI (122)
• CMS (139)
• CSS (50)
• Frontend (75)
• HTML (66)
• JavaScript (150)
• Laravel (72)
• Linux (169)
• MySQL (76)
• PHP (125)
• React.js (66)
• SSH (27)
• Ubuntu (69)
• Web-разработка (509)
• WordPress (73)
• Yii2 (69)
• БазаДанных (95)
• Битрикс (66)
• Блог (29)
• Верстка (43)
• ИнтернетМагаз… (84)
• КаталогТоваров (87)
• Класс (30)
• Клиент (28)
• Ключ (28)
• Команда (87)
• Компонент (60)
• Конфигурация (64)
• Корзина (32)
• ЛокальнаяСеть (32)
• Модуль (34)
• Навигация (31)
• Настройка (141)
• ПанельУправле… (29)
• Плагин (33)
• Пользователь (26)
• Практика (101)
• Сервер (75)
• Событие (27)
• Теория (106)
• Установка (66)
• Файл (51)
• Форма (58)
• Фреймворк (192)
• Функция (36)
• ШаблонСайта (68)

Хуки: фильтры и действия. Подробное руководство

Хук (hook) — в переводе означает крючок.

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

Наши хуки будут делиться на два вида: фильтры и действия.

• Фильтры позволят вам изменить значения каких-либо переменных перед их возвратом функциями.
• Действия позволят вам выполнить какой угодно код там, где висит «крючок».

Чтобы скачать плагин, который получился в процессе этого урока, нужно купить курс.

Пошаговый разбор работы фильтра

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

Делается это в принципе при помощи двух функций — apply_filters() и add_filter().

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

$x = apply_filters( 'misha_filter', $x );

1. После этого мы уже можем воздействовать на эту переменную извне при помощи add_filter(). Для этого например в файле functions.php или в нашем собственном плагине, который мы разрабатываем на протяжении этого курса, мы создаём функцию с произвольным названием, аргумент функции — переменная $x , внутри функции выполняем с ней все необходимые действия и в конце концов возвращаем результативную переменную. Затем, рядом с функцией вызываем add_filter(), в которой в качестве параметров указываем название фильтра и название нашей произвольной функции. Меньше слов, больше дела — вот как это может выглядеть:

add_filter( 'misha_filter', 'misha_function' ); function misha_function( $x ) { $x = '' . $x . ''; // если переменная текстовая, мы просто сделали текст жирным шрифтом return $x; // возвращаем }

Или вот так начиная с версии PHP 5.3

add_filter( 'misha_filter', function( $x ) { $x = '' . $x . ''; // если переменная текстовая, мы просто сделали текст жирным шрифтом return $x; // возвращаем } );

Но у анонимной функции есть минус – такой хук невозможно будет отключить.

1. Стоп! Прежде, чем читать пост дальше, рекомендую опробовать всё это у себя. Вам не обязательно писать для этого плагин — просто в теме, например в header.php выведите переменную $x и перед выводом примените к ней фильтр, а в файле functions.php этот фильтр и наложите.

Пример с фильтром the_content

Скажите, то содержимое поста, которое находится у вас в редакторе в админке и то, которое выводится на сайте одно и то же или отличается?

Вероятно, это одна из тех вещей, которая фильтруется больше всего – при помощи фильтра the_content на содержимое поста накладываются функции wpautop(), wptexturize(), применяются шорткоды. Кроме того, пользователь тоже мог нагуглить какие-нибудь хуки и с их помощью, скажем, выводить кнопки социальных сетей под постом.

Чтобы посмотреть наглядно, попробуйте вставить этот код в удобное место в теме, в footer.php или в произвольный шаблон страницы:

$my_post = get_post( 5 ); // вместо 5 укажите ID интересующей вас записи echo $my_post->post_content; // выводим содержимое поста как оно есть в базе данных $filtered = apply_filters( 'the_content', $my_post->post_content ); // применяем фильтры echo $filtered; // выводим, смотрим, что получилось

Пошаговый разбор работы хука действия

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

Делается всё это так же, как и в случае с фильтрами, двумя функциями — do_action() и add_action()

1. Всё начинается с того, что где-то в коде есть место, в котором потенциально нужно будет выполнить дополнительный код. Это место мы обозначим функцией do_action(), в качестве параметра которой укажем название «крючка». Это будет выглядеть очень просто:

do_action( 'misha_hook' );

1. Теперь на этот «крючок» мы уже можем повесить функцию, которая будет находиться например в functions.php вашем темы или в отдельном плагине. То есть открываем functions.php , создаём там произвольную функцию, затем рядом с ней (не в ней!) выполняем функцию add_action(), в которой указываем название хука и название произвольной функции.

add_action( 'misha_hook', 'misha_function2' ); function misha_function2(){ echo 'Привет, мир!'; }

Ну разве не простой механизм?

Пример с использованием хука wp_head в WordPress

Просто wp_head это первое, что пришло мне сейчас в голову. Итак, прежде всего откройте страницу вашего сайта, откройте её и в виде HTML-кода в браузере. А теперь зайдите в файл header.php и быстрым нажатием клавиши удалите оттуда функцию wp_head() (она и запускает хук). После этого посмотрите, как сильно изменится ваша страница — исчезнут стили, скрипты, возможно какой-то произвольный код, который вы вручную добавляли через этот хук.

Параметры и приоритеты

Приоритеты

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

Покажу простейший пример с использованием анонимных функций (вам нужна версия PHP 5.3.0 или выше) и хуков действий. Если вы вставите этот код куда-нибудь на сайте, то привязанные к хуку функции будут выполняться в порядке подключения в коде

add_action( 'misha_priority', function(){ echo 'A'; } ); add_action( 'misha_priority', function(){ echo 'Б'; } ); add_action( 'misha_priority', function(){ echo 'В'; } ); // сам хук do_action( 'misha_priority' ); // будет выведено АБВ

А теперь внимание — функции add_action() и add_filter() третьим параметров поддерживают указание приоритета, с учетом этого видоизменим наш код.

add_action( 'misha_priority', function(){ echo 'A'; }, 9999 ); add_action( 'misha_priority', function(){ echo 'Б'; }, 5 ); add_action( 'misha_priority', function(){ echo 'В'; }, 10 ); // 10 - значение по умолчанию, поэтому его можно и не указывать // сам хук do_action( 'misha_priority' ); // будет выведено БВА

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

Передача дополнительных аргументов в функцию

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

Всё начинается с того, что в функциях do_action() или apply_filters() указываются один или несколько параметров.

do_action( 'misha_action', $param1, $param2, $param3 );

После этого, четвёртым параметром функции add_action() или add_filter() соответственно вы можете решить, сколько из них можно передать непосредственно в функцию.

add_action( 'misha_action', 'misha_function_1', 10, 3 ); // 3 - количество параметров, можно указать и 2, тогда функция misha_function() примет только два параметра, единицу можно не указывать, так как это значение по умолчанию function misha_function_1( $param1, $param2, $param3 ) { . }

Отключение хуков и действий

Всего для этих целей в WordPress существует 4 функции:

• remove_filter() — для отключения конкретной функции с фильтра.
• remove_action() — для удаления конкретной функции с хука действия.
• remove_all_filters() — для полной очистки хука фильтра.
• remove_all_actions() — для полной очистки хука действия.

Пример для WooCommerce, удаляющий опции сортировки со страницы «Магазин» и категорий товаров:

remove_action( 'woocommerce_before_shop_loop', 'woocommerce_catalog_ordering', 30 );

Купить курс

• 11 видеоуроков
• Можно скачать готовый код после каждого урока
• Можно начать проходить курс сразу же после оплаты
• Единоразовый платёж
• Доступ навсегда
• Уроки актуальны в 2023-м году

10 полезных хук-хаков для WordPress

О том, что такое хуки в WordPress и как их там использовать. Статья молодого WordPress-специалиста, владельца сайта www.wprecipes.com, из Бельгии.

ВВЕДЕНИЕ

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

ЧТО ТАКОЕ ХУК?

Для достижения определенного эффекта нам нужно слегка изменить принцип работы WordPress. Некоторые модификации необходимо внести в файлы, которые были названы разработчиками файлами ядра – они нужны для того, чтобы WordPress работал должным образом.
Но изменение файлов ядра – плохая идея: это может создать брешь в системе безопасности блога. Также, все модификации исчезнут, как только Вы обновите движок до новой версии.
Однако, расширение функциональности все же необходимо. Для этого разработчиками был придуман Plugin API.
Хуки являются одним из главных блоков для построения плагинов. Почти каждый подключаемый плагин использует хуки для расширения функциональности WordPress.

КАК ИСПОЛЬЗОВАТЬ ХУКИ В ВАШЕМ БЛОГЕ

Пока Вы не написали свой плагин, Вы должны записать хуки в файл functions.php. Этот файл находится в директории wp-content/themes/yourtheme (где /yourtheme – директория, в которой находится текущая тема).
Вот пример, который показывает, как подключить Вашу пользовательскую функцию к функции ядра движка:

1. add_action ( ‘publish_post’ , ‘myCustomFunction’ ) ;

В этом примере мы подключили пользовательскую функцию myCustomFunction() к функции ядра publish_post(). Функция myCustomFunction() будет выполняться при каждом выполнении функции publish_post().
Конечно, мы можем также удалить хук, используя функцию remove_action():

1. remove_action ( ‘publish_post’ , ‘myCustomFunction’ ) ;

1. ОТКЛЮЧАЕМ АВТОМАТИЧСКОЕ ФОРМАТИРОВАНИЕ В WORDPRESS

Проблема.

Вы, наверное, уже замечали, что типограф WordPress по умолчанию превращает «прямые» кавычки в «кривые» и делает другие мелкие изменения в форматировании поста.
Это хорошо, если блоггер размещает обычный контент (подразумеваются обычный текст и картинки). Но некоторые постят исходный код, чтобы потом его обсуждать, и они будут очень недовольны, когда из-за этих «кривых» кавычек интерпретатор иди компилятор выдадут им сообщения о синтаксических ошибках.

Решение.

Просто вставьте в файл functions.php нижеследующий код:

1. function my_formatter ( $content )
2. $new_content = » ;
3. $pattern_full = ‘<(\[raw\].*?\[/raw\])>is’ ;
4. $pattern_contents = ‘is’ ;
5. $pieces = preg_split ( $pattern_full , $content , — 1 , PREG_SPLIT_DELIM_CAPTURE ) ;
6. foreach ( $pieces as $piece )
7. if ( preg_match ( $pattern_contents , $piece , $matches ) )
8. $new_content .= $matches [ 1 ] ;
9. > else
10. $new_content .= wptexturize ( wpautop ( $piece ) ) ;
11. >
12. >
13. return $new_content ;
14. >
15. remove_filter ( ‘the_content’ , ‘wpautop’ ) ;
16. remove_filter ( ‘the_content’ , ‘wptexturize’ ) ;
17. add_filter ( ‘the_content’ , ‘my_formatter’ , 99 ) ;

После того, как Вы это сделали, можете использовать тэг [raw] для того, чтобы текст поста был не отформатирован автоматически:

[raw]This text will not be automatically formatted.[/raw]

Объяснение кода.

Первым делом, мы создаем функцию, которая, основываясь на регулярных выражениях, находит тэг [raw] в содержании Вашего поста.
Далее, мы привязываем нашу функцию my_formatter() к функции the_content(), что означает выполнение нашей функции всякий раз, когда вызывается функция the_content().
Для того, чтобы отключить автоформатирование, мы использовали функцию remove_filter().

2. ОПРЕДЕЛЯЕМ БРАУЗЕР ПОСЕТИТЕЛЯ ПРИ ПОМОЩИ ХУКОВ

Проблема.

Кросс-браузерная совместимость – это наиболее распространенная проблема в web-разработке. Вы сэкономите много нервов и времени, если сможете определить браузер пользователя, зашедшего на Ваш блог, а затем создав CSS-класс для тэга body под каждый из браузеров.

Решение.

Ничего сложного: просто вставьте нижеследующий код в файл functions.php, сохраните его – все готово!

1. add_filter ( ‘body_class’ , ‘browser_body_class’ ) ;
2. function browser_body_class ( $classes )
3. global $is_lynx , $is_gecko , $is_IE , $is_opera , $is_NS4 , $is_safari , $is_chrome , $is_iphone ;
4. if ( $is_lynx ) $classes [ ] = ‘lynx’ ;
5. elseif ( $is_gecko ) $classes [ ] = ‘gecko’ ;
6. elseif ( $is_opera ) $classes [ ] = ‘opera’ ;
7. elseif ( $is_NS4 ) $classes [ ] = ‘ns4’ ;
8. elseif ( $is_safari ) $classes [ ] = ‘safari’ ;
9. elseif ( $is_chrome ) $classes [ ] = ‘chrome’ ;
10. elseif ( $is_IE ) $classes [ ] = ‘ie’ ;
11. else $classes [ ] = ‘unknown’ ;
12. if ( $is_iphone ) $classes [ ] = ‘iphone’ ;
13. return $classes ;
14. >

После того, как Вы сохраните файл, функция автоматически будет добавлять CSS-класс, соответствующий пользовательскому браузеру, для тэга body:

Объяснение кода.

WordPress имеет глобальные переменные, которые возвращают true, если пользователь использует соответствующий браузер. Если пользователь использует браузер Google Chrome, то переменная $is_chrome примет значение true. Вот для чего мы и создаем функцию browser_body_class(). После этого мы присоединяем ее к WordPress функции body_class().

3. ОПРЕДЕЛЕНИЕ ТЕКСТА ПО УМОЛЧАНИЮ В РЕДАКТОРЕ TinyMCE

Проблема.

Многие блоггеры почти всегда используют для своего блога один и тот же формат. Сообщения в моем блоге WpRecipes.com всегда отображаются одинаково: текст, код, еще немного текста.
Можно сэкономить немало времени, если научить TinyMCE отображать какой-нибудь текст по умолчанию.

Решение.

Как всегда, решением является хук. Копируем код в файл functions.php и смотрим, как он работает.

1. add_filter ( ‘default_content’ , ‘my_editor_content’ ) ;
2. function my_editor_content ( $content )
3. $content = «If you enjoyed this post, make sure to subscribe to my rss feed.» ;
4. return $content ;
5. >

Объяснение кода.

Этот код хоть и простой, но очень мощный. Просто создаем функцию, которая возвращает требуемый текст (в этом примере мы определяем текст, который спрашивает у посетителей о подписке на RSS-ленту), и присоединяем ее к WordPress-функции default_content(). Вот так.

4. ВСТАВЛЯЕМ КОНТЕНТ АВТОМАТИЧЕСКИ ПОСЛЕ КАЖДОГО ПОСТА

Проблема.

В большинстве блогов для вывода контента после каждого поста файл single.php, но вот беда: этот контент не будет отображаться в RSS-ленте. Хуки помогут исправить эту проблему.

Решение.

Все то же самое – просто копируем следующий код в файл fucntions.php.

1. function insertFootNote ( $content )
2. if ( ! is_feed ( ) && ! is_home ( ) )
3. $content .= «
   » ;
4. $content .= «
   

   Enjoyed this article?

   » ;

5. $content .= «

   Subscribe to our RSS feed and never miss a recipe!

   » ;

6. $content .= «

add_action( 'save_post', 'notify_administrator', 10, 3 ); function notify_administrator( $post_id, WP_Post $post, $update ) < // Really important code here . wp_mail( $admin_email, $subject, $message ); >add_filter( 'post_class', 'modify_post_classes', 10, 3 ); function modify_post_classes( $classes, $class, $post_id ) < if ( in_array( get_post_type( $post_id ), [ 'review', 'service' ] ) ) < $classes[] = 'dark-theme'; >return $classes; >

// Запуск кода. // Загружаем 1-й плагин add_action( 'before_magic', 'say_hi' ); // Записываем в хранилище // Загружаем 2-й плагин add_action( 'before_magic', 'introduce_yourself' ); // Записываем в хранилище // Загрузили все плагины // Загружаем активную тему add_action( 'after_magic', 'applause' ); // Записываем в хранилище // Загрузили тему function magic() < do_action( 'before_magic' ); // Запускаем все колбэк-фукнкции из хранилища, которые относятся к этому действию. Но после запуска самой фукнции (не сейчас, чуть позже) $this->take_hat(); $this->stick_your_hand_in_your_hat(); $this->get_hare(); do_action( 'after_magic' ); // Запускаем все колбэк-фукнкции из хранилища, которые относятся к этому действию. Но после запуска самой фукнции (не сейчас, чуть позже) > // Несколько миллисекунд спустя. // Запускаем какую-то страницу в которой находится код шорткода например: magic(); // Запускатся функция magic, и в ней уже выполняются все колбэк-фукнции которые вы добавили на хуки before_magic и after_magic.

function do_something_awesome() < // . >/** * 1. Имя функции. */ is_callable( 'do_something_awesome' ); // true class Awesome < public static function do_something() < // . >public function do_something_more() < >/** * 4. Методы внутри другого метода. */ public function hooks() < is_callable( [ $this, 'do_something' ] ); // true is_callable( [ $this, 'do_something_more' ] ); // true is_callable( [ __CLASS__, 'do_something' ] ); // true is_callable( 'self::do_something_more' ); // true >public function __invoke( . $values ) < >> $awesome = new Awesome(); $awesome->hooks(); /** * 2. Имя статического метода. */ is_callable( 'Awesome::do_something' ); // true is_callable( [ 'Awesome', 'do_something' ] ) ; // true is_callable( [ Awesome::class, 'do_something' ] ); // true is_callable( [ $awesome, 'do_something' ] ); // true /** * 3. Имя метода объекта $awesome. */ is_callable( [ $awesome, 'do_something_more' ] ); // true /** * 4. Если класс имеет __invoke метод, значит мы можем вызвать класс, как функцию - значит сам объект является колбэком. */ is_callable( $awesome ); // true /** * 5. Анонимная функция. */ is_callable( function () < // true >);