is_main_query()

[nacin]

Often times, it's very beneficial to check whether you're working with the main query. Examples might include operations on the pre_get_posts action.

Developers with knowledge of the internals know to compare the query object against $wp_the_query, but that is rather cryptic and pretty hidden. Most documentation I can find on the usage of query_posts(), WP_Query, and get_posts() fail to mention $wp_the_query anywhere. Though, they do often mention wp_reset_query(), which restores $wp_query from $wp_the_query.

It'd be nice to expose a new function and new WP_Query method to leverage this. Attached patch introduces is_main_query() and the corresponding method.

[scribu]

+1 from me.

[westi]

+∞

[nacin]

In [18699]:

is_main_query(). fixes #18677.