apply_filters_ref_array( 'posts_clauses', string[] $clauses , WP_Query $query )
Filters all query clauses at once, for convenience.
Contents
Description
Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, fields (SELECT), and LIMIT clauses.
Parameters
-
$clauses
string[] -
Associative array of the clauses for the query.
where
stringThe WHERE clause of the query.groupby
stringThe GROUP BY clause of the query.join
stringThe JOIN clause of the query.orderby
stringThe ORDER BY clause of the query.distinct
stringThe DISTINCT clause of the query.fields
stringThe SELECT clause of the query.limits
stringThe LIMIT clause of the query.
-
$query
WP_Query -
The WP_Query instance (passed by reference).
More Information
The posts_clauses
filter runs before the query gets executed and is essentially the sum of all filters that run immediately before it. So it should be used if you don’t intend to let another plugin override it, or if you need to alter several different parts of the query at once. If you’re only modifying a particular clause, you should probably use one of these clause-specific filters:
* posts_where_paged
* posts_groupby
* posts_join_paged
* posts_orderby
* posts_distinct
* post_limits
* posts_fields
Note: If you’re working on a caching plugin, use the posts_clauses_request filter instead. It’s basically the same filter, but it runs later (and after posts_selection), specifically so that “regular” plugins can execute their filters before your caching plugin does anything.
Source
File: wp-includes/class-wp-query.php
.
View all references
$clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example migrated from Codex:
In the following example, you can see how you can inspect the current query.
If you need to alter anything, simply set the
$pieces['whatever_part']
string to what you need. Be sure to use appropriate $wpdb properties and methods (e.g.$wpdb->prefix, $wpdb->prepare()
) in your SQL to prevent injection attacks, handle table prefix variations, and so forth.This would be the output on the Admin “All Posts” example.com/wp-admin/edit.php screen: