is_main_query() │ WP 3.3.0

Проверяет в главном ли цикле WordPress выполняется действие. Условный тег.

Функцию нужно использовать только внутри циклов, так как тег предназначен для определения главного цикла WordPress.

Работает на основе: WP_Query::is_main_query()

1 раз — 0.000011 сек (очень быстро) | 50000 раз — 0.01 сек (скорость света) | PHP 7.0.14, WP 4.7

Хуков нет.

Возвращает

true|false.

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

if( is_main_query() ){ ... };

Примеры

#1 Выполним код, только если это главный цикл:

if( is_main_query() ){
	 // здесь код который нужно выполнить.
}

#2 Как исключить категорию из основного цикла

Альтернативный пример, показывающий как изменить только основной цикл и исключить из него категорию 5. Разумеется исключать категорию 5 будем, только в том случае, если в запросе не указан параметр cat (напрямую не указана категория). Для этого мы будем использовать фильтр (хук) pre_get_posts:

add_action( 'pre_get_posts', 'foo_modify_query_exclude_category' );
function foo_modify_query_exclude_category( $query ) {
	if ( $query->is_main_query() && ! $query->get( 'cat' ) )
		$query->set( 'cat', '-5' );
}

Заметки

Global. WP_Query. $wp_query WordPress Query object.

Список изменений

С версии 3.3.0

Введена.

Код `is_main_query() is main query` ^{WP 6.6.2}

wp-includes/query.php

function is_main_query() {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '6.1.0' );
		return false;
	}

	if ( 'pre_get_posts' === current_filter() ) {
		_doing_it_wrong(
			__FUNCTION__,
			sprintf(
				/* translators: 1: pre_get_posts, 2: WP_Query->is_main_query(), 3: is_main_query(), 4: Documentation URL. */
				__( 'In %1$s, use the %2$s method, not the %3$s function. See %4$s.' ),
				'<code>pre_get_posts</code>',
				'<code>WP_Query->is_main_query()</code>',
				'<code>is_main_query()</code>',
				__( 'https://developer.wordpress.org/reference/functions/is_main_query/' )
			),
			'3.7.0'
		);
	}

	return $wp_query->is_main_query();
}

Денис

Добрый день!
Использовал алтернативный метод

function prefix_pre_get_posts($query) {
	if ($query->is_main_query()){
		$query->set('orderby', 'comment_count');
	}
	 return $query;
}
add_action('pre_get_posts', 'prefix_pre_get_posts');

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

10.8 лет назад #

Kama9744
Используйте условные тег. Например так, для всего кроме админки:
```
function prefix_pre_get_posts($query) {
	// выходим если это админ-панель
	if( is_admin() )
		return;

	if ($query->is_main_query()){
		$query->set('orderby', 'comment_count');
	}
	 return $query;
}
add_action('pre_get_posts', 'prefix_pre_get_posts');
```
Еще пример, если нужно чтобы сработало только для главной страницы блога:
```
if( ! is_front_page() )
		return;
```
П.С. Вы используете хук, который срабатывает всякий раз, когда вызывается WP_query, а на его основе строятся все запросы в WP связанные с записями.
0

10.8 лет назад #
- Денис
  Большое спасибо за столь быстрый ответ!
  А возможно ли сделать чтоб этот хук срабатывал только для записей типа 'post'?
  
  Ведь сортируются и страницы...
  
  кроме того я использую сортировку по произвольному полю:
```
$query->set('orderby', 'meta_value');
$query->set('meta_key', 'vk_comments_number');
$query->set('order','ASC');
```
  У страниц этого поля вообще нет, поэтому при переходе на страницу получаю 404ю
  0
  
  10.8 лет назад #

Олег

Что такое главный цикл WordPress?
Допустим, есть какой-то цикл.
Как понять, он главный или нет?

7.1 год назад #

Kama9744

Есть спец. функция is_main_query() внутри цикла надо использовать...

0

7.1 год назад #

is_main_query() │ WP 3.3.0

Возвращает

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

Примеры

#1 Выполним код, только если это главный цикл:

#2 Как исключить категорию из основного цикла

Заметки

Список изменений

Код is_main_query() is main query WP 6.6.2

Cвязанные функции

Условные теги (все)

Запросы

Код `is_main_query() is main query` ^{WP 6.6.2}