Add filter

add_filter (string $tag, callable$ function_to_add, int $priority = 10, int$ accepted_args = 1)  

Подключить функцию или метод к конкретному действию фильтра.

WordPress предлагает фильтры, позволяющие плагинам изменять различные типы внутренних данных во время выполнения.

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

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

Обратите внимание, что $примера передается функция обратного вызова, (может быть) изменено, а затем вернулся:

function example_callback($ example) {   // Maybe modify $example in some way.   return$ example;  }  add_filter('example_filter', 'example_callback');  

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

вызова ,

Другими словами, если вызов apply_filters() передает четыре общих аргумента, обратные вызовы, связанные с , он не может принимать ни одно (то же, что и 1) аргументов, либо до четырех. Важная часть состоит в том, что значение $accepted_args должно отражать количество аргументов, которые связанный обратный вызов фактически решил принять. Если никакие аргументы не были приняты обратным вызовом, который считается таким же, как прием 1 аргумента. Например:

// Filter call.$ value = apply_filters('hook', $value,$ arg2, $arg3);   // Accepting zero/one arguments.  function example_callback(){   ...   return 'some value';  } add_filter('hook', 'example_callback'); // Where$ priority is default 10, $accepted_args is default 1.   // Accepting two arguments (three possible).  function example_callback($ value, $arg2){   ...   return$ maybe_modified_value;  }  add_filter('hook', 'example_callback', 10, 2); // Where $priority is 10,$ accepted_args is 2.  

Примечание: Функция возвращает истину, является ли действительным обратного вызова. Вы должны заботиться о себе. Это делается для целей оптимизации, поэтому все как можно быстрее.

wordpress.stackovernet.com

Большинство из приведенных ниже можно найти в Codex :

---

apply_filters

Функции обратного вызова, связанные с $tag hook hook $tag , вызываются вызовом этой функции. Эта функция может быть использована для создания нового фильтра, просто вызвав эту функцию с именем нового крючка, указанного с помощью параметра $ tag.

 $value = apply_filters( $tag, $value, $var_1, $var_2, ... );  

  
  

По существу:
Вы используете apply_filters для фильтрации данного $value – по отношению к самому значению, а также необязательно предоставленные переменные $var_1 через $var_n .

---

add_filter

Подключите функцию к конкретному действию фильтра.

 add_filter( $tag, $function_to_add, $priority, $accepted_args );  

  
  

По существу:
Вы используете add_filter для add_filter пользовательской функции к данному действию фильтра ( $tag ), который раньше вы могли сгенерировать с помощью apply_filters (или это было встроенное действие фильтра или проистекало из плагина / вашей темы).

---

Итак, вот вымышленный пример:

 function print_initials( $name ) { if ( ! is_string( $name ) ) { return; } $fragments = explode( ' ', $name ); /** * Filter wether to print initials in reverse order. * * @param bool $reverse Print initials in reverse order? */ if ( apply_filters( 'reverse_initials', FALSE ) ) { $fragments = array_reverse( $fragments ); } foreach ( $fragments as $f ) { echo substr( $f, 0, 1 ); } } print_initials( 'Some Guy' ); // outputs: SG add_filter( 'reverse_initials', '__return_true' ); print_initials( 'Some Guy' ); // outputs: GS 

Теперь, если мы просто вызываем нашу функцию как есть, .

438;е по умолчанию.

Во второй раз мы получаем инициалы в обратном порядке, потому что функция фильтра __return_true , привязанная к нашему действию фильтра, всегда возвращает TRUE и, таким образом, выводит начальные значения справа налево.

www.wordpressask.com

add_filter() является вспомогательной функцией apply_filters(). Прежде чем apply_filters будет запущен для определенного фильтра (аргумент $tag в add_filter()), вы можете использовать add_filter для регистрации фильтра для тега. Когда apply_filters() выполняется с этим именем тега, он вызывает все зарегистрированные фильтры в порядке. Фильтры используются для передачи данных через функции манипуляции. Например, я часто использую фильтр wp_list_pages. Я использую его для удаления разрывов строк из списка страниц. Итак, как это работает:

Сначала я определяю функцию, которая принимает один параметр и возвращает его после работы с ним:

function my_list_pages_filter($pages){  $pages = preg_replace( array("n","r"), '', $pages );  return $pages; } 

Затем я добавляю крючок фильтра: add_filter (‘wp_list_pages’, ‘my_list_pages_filter’);

add_filter

сообщает WordPress «Когда вызывается функция apply_filters с первым аргументом» wp_list_pages «, вызовите my_list_pages_filter«. Фильтры должны отправлять хотя бы одно значение (любого типа: string, array, integer и т.д.), И они ожидают, что функция вернет одно значение.

Они предоставляют вам способ управления вводом перед отправкой.

do_action — совершенно другой крючок. Чтобы отправить информацию в вашу функцию фильтра, сделайте следующее (взятое из вашего примера):

<div id="content" <?php $class='post post_content'; echo apply_filters('my_custom_classes', $class); ?>> 

И затем в файле functions.php добавьте следующее:

add_filter('my_custom_classes','my_custom_classes_function'); function my_custom_classes_function($classes){  $output 'class="'. $classes.'"';  return $output; } 

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

function my_custom_classes_function($classes){  $classes = explode( ' ', $classes );  if(is_home())  $classes[] = 'home_content';  if(is_single())  $classes[] = 'single_content';  if(is_page())  $classes[] = 'page_content';  if(is_tag())  $classes[] = 'tag_content';  $output 'class="'. implode( ' ', $classes ) .'"';  return $output; }   

  
 

qaru.site

Примеры

Добавим произвольную строку в конце всех заголовков постов

Вряд ли это может вам понадобиться, но такой вот простой пример.

Множество других примеров на truemisha.ru

Прежде всего я рекомендую вам почитать полное руководство по фильтрам в WordPress.

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

misha.blog

Что такое WordPress — фильтр

В Кодексе WordPress фильтрам дано следующее определение:

Итак, фильтр это функция на php, которая записывается в стек вызовов встроенной системы фильтров WordPress. Но в себе она может содержать сторонние функции и другие конструкции. Фильтр является одним из двух видов хуков (hooks) в WordPress. Второй — действие (action), но это предмет для другой серии статей.

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

Используем фильтры в WordPress

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

В этой статье мы собираемся проделать четыре вещи:

• Создадим функцию фильтра;
• Сделать из нее хук;
• Убрать функцию из фильтра;
• Создать свой собственный фильтр.

Создаем функцию и прикрепляем ее к фильтру

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

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

Сложно? На самом деле, нет. В приведенном ниже примере, мы напишем код функции, которая удаляет гласные во всем тексте:

Функция берет строку заголовка $title, удаляет гласные и возвращает строку. Довольно просто, верно? Теперь прыгнем на уровень выше, сделаем хук, и прицепим его к фильтру:

Заметили новую функцию? Взглянем на add_filter():

• $tag (обязательный параметр) – имя фильтра;
• $function_to_add (обязательный параметр) – имя функции для хука;
• $priority (опция) – Целое число для определения момента исполнения функции. По умолчанию равно 10: Функция сработает раньше, если вы снизите значение, и позже, если вы повысите его;
• $accepted_args (опция) — Значение, нужное чтобы определить количество аргументов, которые пропускает фильтр. Значение по умолчанию равно1.

Удаляем фильтр

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

Параметры такие же, как и в случае с add_filter():

• $tag (обязательный параметр) – имя фильтра;
• $function_to_remove (обязательный параметр) – имя функции для удаления;
• $priority (опция) — приоритет функции (определено при первом подключении функции).

Еще одна функция, remove_all_filters(), у которой всего лишь два параметра ($tag и $priority), в которых указываются имя функции и приоритет. Имя функции говорит само за себя. Она отключает все функции, прицепленные к фильтру.

Создаем свой собственный фильтр

Хотите знать, как создаются фильтры? Для этого существует специальная функция apply_filters(), находящаяся в ядре. Конечно же, ее можно использовать и вне ядра, и это означает то, что мы можем создавать фильтры внутри наших плагинов.
Посмотрим, как это работает на практике:

• $tag (обязательный параметр) – имя привязываемой функции;
• $value (обязательный параметр) — значение, которое будет меняться функцией, подключенной к фильтру через add_filter();
• $var1, $var2 и так далее (опционально) – параметры фильтра (столько, сколько потребуется). Функция фильтра может использовать эти параметры, но они не смогут быть возвращены функциями.

Подумаем над таким примером: Представьте, что вы пишите функцию, которая возвращает только известную цитату Питера Гриффина:

Если вы хотите дать возможность пользователю отфильтровать эту цитату (не трогая код вашего плагина), вам нужно использовать функцию apply_filters() следующим образом:

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

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

Заключение

Чем больше вы работаете с фильтрами, тем веселее идут дела. Есть сотни фильтров, и, изучая их, вы каждый раз подходите на один шаг ближе к тому, чтобы стать WordPress — гуру. В следующей части этой серии статей мы собираемся рассказать о 10 WordPress — фильтрах:

• login_errors;
• comment_post_redirect;
• allowed_redirect_hosts;
• body_class;
• locale;
• sanitize_user;
• the_content;
• the_password_form;
• the_terms;
• wp_mail_from.

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

И если вам понравилось то, что вы читаете в этой статье, не забудьте поделиться ею!

Увидимся на следующем уроке!

Перевод статьи “50 Filters of WordPress: An Introduction to Filters” был подготовлен дружной командой проекта Сайтостроение от А до Я.