split_the_query │ filter-hook │ WP 3.4.0

Filters whether to split the query.

Splitting the query will cause it to fetch just the IDs of the found posts (and then individually fetch each post by ID), rather than fetching every complete row at once. One massive result vs. many small results.

Usage

add_filter( 'split_the_query', 'wp_kama_split_the_query_filter', 10, 4 );

/**
 * Function for `split_the_query` filter-hook.
 * 
 * @param bool     $split_the_query Whether or not to split the query.
 * @param WP_Query $query           The WP_Query instance.
 * @param string   $old_request     The complete SQL query before filtering.
 * @param string[] $clauses         Associative array of the clauses for the query.
 *
 * @return bool
 */
function wp_kama_split_the_query_filter( $split_the_query, $query, $old_request, $clauses ){

	// filter...
	return $split_the_query;
}

$split_the_query(true|false)

Whether or not to split the query.

$query(WP_Query)

The WP_Query instance.

$old_request(string)

The complete SQL query before filtering.

$clauses(string[])

Associative array of the clauses for the query.

• where(string)
  The WHERE clause of the query.

• groupby(string)
  The GROUP BY clause of the query.

• join(string)
  The JOIN clause of the query.

• orderby(string)
  The ORDER BY clause of the query.

• distinct(string)
  The DISTINCT clause of the query.

• fields(string)
  The SELECT clause of the query.

• limits(string)
  The LIMIT clause of the query.

Changelog

Where the hook is called

$split_the_query = apply_filters( 'split_the_query', $split_the_query, $this, $old_request, compact( $pieces ) );

Where the hook is used in WordPress