it-swarm-ru.tech

Разница между фильтрами и хуками действий?

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

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

Помимо семантики и для чего они используются, какие реальные различия между ними?

49
Sruly

Привет @Sruly:

Вы в значительной степени ответили на свой вопрос, но я немного уточню.

Action Hooks

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

  1. Используйте echo для вставки некоторого HTML или другого содержимого в буфер ответов,
  2. Изменить состояние глобальной переменной для одной или нескольких переменных и/или
  3. Измените параметры, передаваемые вашей функции ловушки (при условии, что ловушка была вызвана do_action_ref_array() вместо do_action(), поскольку последняя не поддерживает передачу переменных по ссылке .)

Крючки фильтра

Хуки-фильтры ведут себя очень похоже на Хуки-действия , но они предназначены для получения значения и потенциально могут вернуть измененную версию значения. Хук фильтра также может быть использован точно так же, как хук действий, то есть для изменения глобальной переменной или генерации некоторого HTML, при условии, что это то, что вам нужно сделать, когда вызывается хук. Одна вещь, которая очень важна в Filter Hooks, о которой вам не нужно беспокоиться с Action Hooks, это то, что человек, использующий Filter Hook _ must , возвращает (измененную версию) первого параметра это было пройдено. Распространенная ошибка новичка - забыть вернуть это значение!

Использование дополнительных параметров для обеспечения контекста в хуках фильтров

В качестве отступления Я чувствовал, что в предыдущих версиях WordPress блокировка фильтра была затруднена, поскольку они получали только один параметр; то есть они получат значение, которое нужно изменить, но не будут иметь 2-го или 3-го параметра, чтобы обеспечить какой-либо контекст. Однако в последнее время и, что положительно, кажется, что основная команда WordPress с радостью (для меня) добавила дополнительные параметры в фильтр-хуки, чтобы вы могли узнать больше контекста. Хорошим примером является хук posts_where; Я полагаю, что в нескольких версиях назад он принимал только один параметр, являющийся текущим запросом "где" класс SQL, но теперь он принимает и предложение where и ссылку на текущий экземпляр класса WP_Query это вызывает крюк.

Так в чем же реальная разница?

На самом деле Filter Hooks - это в значительной степени расширенный набор Action Hooks. Первый может делать все, что может делать второй, и, более того, разработчик не обязан возвращать значение с помощью Action Hook, что он или она делает с Filter Hook.

Давать руководство и телеграфный замысел

Но это, вероятно, не то, что важно. Я думаю, что важно то, что разработчик, решивший использовать Action Hook вместо Filter Hook или наоборот, он телеграфирует свое намерение и, следовательно, дает руководство разработчику или плагину, который может быть используя крючок. По сути, они говорят либо "Я собираюсь позвонить вам, делайте все, что вам нужно сделать" ИЛИ "Я собираюсь передать вам это значение для изменения, но убедитесь, что вы передаете его обратно . "

Итак, в конечном итоге я думаю, что руководство, обеспечиваемое выбором типа крючка, является реальной ценностью различия. ИМО, во всяком случае.

Надеюсь это поможет!

56
MikeSchinkel

Если вы посмотрите на источник основной функции add_action(), то это просто оболочка для функции add_filter() ...

И если вы посмотрите на базовую функцию do_action(), она очень похожа на базовую функцию apply_filters(), но с одним существенным отличием: она не возвращает значение.

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

11
trusktr

В простых словах.

Действия это те функции PHP, которые выполняют вывод.

Фильтры это те функции PHP, которые возвращают вывод.

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


Как пользоваться?

Действие:

Ниже приведены простые примеры в вашем файле functions.php темы.

  1. Пример первый: (Простой PHP пример)
 function test () {
 echo "Output"; 
} 
 
 test (); 

Над программой выведите вывод:

Выход

[ПРИМЕЧАНИЕ: здесь test () просто вызывает функцию. И выполните функцию обратного вызова 'test'.]


  1. Пример второй: (Простое использование Action)
 function test1 () {
 echo "Output"; 
} 
 add_action ('test', 'test1'); 
 
 do_action ('test'); 

Над программой выведите вывод:

Выход

[ПРИМЕЧАНИЕ: здесь do_action('test') работает как вызывающая функция. И выполните функцию обратного вызова 'test1'.]


  1. Пример третий: (Другое использование Actions)
 function test2 () {
 echo "Test 2"; 
} 
 add_action ('test', 'test2', 1); 
 
 function test1 () {
 echo "Test 1"; 
} 
 add_action ('test', 'test1', 2); 
 
 do_action ('test'); 

Над программой выведите вывод:

 Тест 2Test 1 

[ПРИМЕЧАНИЕ: здесь do_action('test') работает как вызывающая функция. И выполнять функции обратного вызова по своим приоритетам.

Функция обратного вызова "test1" имеет приоритет 2, а "test2" имеет приоритет 1.]

Если приоритеты изменяются как "test1" с приоритетом 1 и "test2" с приоритетом 2, то результат будет:

 Тест 1, тест 2 

  1. Пример четвертый: (поддержка сторонних производителей) Добавить приведенный ниже код в functions.php
 function test1 () {
 do_action ('test_before'); 
 echo "Test 1"; 
 do_action ('test_after'); 
 } 
 add_action ('test', 'test1'); 
 
 do_action ('test'); 

Над программой выведите вывод:

 Тест 1 

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

  1. Создайте папку 'simple' в каталоге /wp-content/plugins/.
  2. Создайте файл с именем 'simple.php' и добавьте приведенный ниже код.
/* 
 * Имя плагина: Простой плагин 
 */
 Function test_callback_function () {
 Echo "From plugin"; 
} 
 add_action ('test', 'test_callback_function'); 

Теперь активируйте наш Простой плагин с панели администратора WordPress.

Перейти в плагин меню и активировать его.

После активации плагина над программой распечатайте вывод:

 Тест 1 из плагина 

[ПРИМЕЧАНИЕ: если мы добавим приоритет для нашего действия плагина от 1 до 9, тогда он напечатает вывод как:

 Из плагинаТест 1 

Потому что WordPress учитывает 10 priority by default для всех добавленных действий.]

Фильтры

Проверьте следующие примеры:

Простой PHP пример:

 $ data = array ('one', 'two'); 
 print_r ($ data); 

Над программой выведите вывод:

 Массив ([0] => один [1] => два) 
  1. Пример первый: (Простое использование фильтра)
 $ data = apply_filters ('my_filter_name', массив ('one', 'two')); 
 print_r ($ data); 
 
 add_filter (' my_filter_name ', function ($ old_data) {
 возвращаемый массив (' three ',' four '); 
}); 

Над программой выведите вывод:

 Массив ([0] => три [1] => четыре) 

Здесь мы добавили фильтр my_filter_name и изменили существующий вывод array( 'one', 'two' ) на array( 'three', 'four' ) без изменения файлов тем/плагинов.


4
maheshwaghmare