comments_pre_query — filter WordPress: параметры и применение

Сигнатура

apply_filters_ref_array( 'comments_pre_query', array|int|null $comment_data, WP_Comment_Query $query )

Описание

Верните значение, отличное от null, чтобы обойти стандартные запросы комментариев WordPress.
Ожидаемый тип возвращаемого значения этого фильтра зависит от значения, переданного в переменных запроса:

Если задано $this->query_vars['count'], фильтр должен вернуть количество комментариев в виде целого числа.

Если 'ids' === $this->query_vars['fields'], фильтр должен вернуть массив идентификаторов комментариев.

В противном случае фильтр должен вернуть массив объектов WP_Comment.

Обратите внимание, что если фильтр возвращает массив данных комментариев, он будет присвоен свойству comments текущего экземпляра WP_Comment_Query.
Функциям фильтрации, которым требуется информация о разбиении на страницы, рекомендуется задавать свойства found_comments и max_num_pages объекта WP_Comment_Query, передаваемого в фильтр по ссылке. Если WP_Comment_Query не выполняет запрос к базе данных, у него не будет достаточно информации для самостоятельного вычисления этих значений.

Оригинал (английский)

Return a non-null value to bypass WordPress’ default comment queries.

The expected return type from this filter depends on the value passed in the request query vars:

When $this->query_vars['count'] is set, the filter should return the comment count as an integer.
When 'ids' === $this->query_vars['fields'], the filter should return an array of comment IDs.
Otherwise the filter should return an array of WP_Comment objects.

Note that if the filter returns an array of comment data, it will be assigned to the comments property of the current WP_Comment_Query instance.

Filtering functions that require pagination information are encouraged to set the found_comments and max_num_pages properties of the WP_Comment_Query object, passed to the filter by reference. If WP_Comment_Query does not perform a database query, it will not have enough information to generate these values itself.

Фильтруемое значение

Верните массив данных комментариев, чтобы прервать запрос комментариев WP, количество комментариев в виде целого числа, если задано $this->query_vars['count'], или null, чтобы WP выполнил обычные запросы.

Параметры

$comment_data array|int|null обязательный

Верните массив данных комментариев, чтобы прервать запрос комментариев WP, количество комментариев в виде целого числа, если задано $this->query_vars['count'], или null, чтобы WP выполнил обычные запросы.

$query WP_Comment_Query обязательный

Экземпляр WP_Comment_Query, передаваемый по ссылке.

Исходный код

wp-includes/class-wp-comment-query.php:434

$comment_data = apply_filters_ref_array( 'comments_pre_query', array( $comment_data, &$this ) );

История изменений

Версия	Описание
5.6.0	The returned array of comment data is assigned to the comments property of the current WP_Comment_Query instance.
5.3.0	Introduced.