posts_clauses_request WordPress Filter Hook

The posts_clauses_request hook is one of the most versatile and powerful hooks available to WordPress developers. It allows you to modify the SQL clauses used to retrieve posts from the database, giving you complete control over the data that is returned. This hook is especially useful for custom post types, as it allows you to customize the SQL queries used to retrieve them.

apply_filters_ref_array( 'posts_clauses_request', string[] $clauses, WP_Query $query ) #

Filters all query clauses at once, for convenience.


Description

For use by caching plugins.

Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, fields (SELECT), and LIMIT clauses.


Top ↑

Parameters

$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.

$query

(WP_Query)The WP_Query instance (passed by reference).


Top ↑

Source

File: wp-includes/class-wp-query.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
3.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More