wppaste
WordPress

apply_filters_ref_array( 'comments_clauses', string[] $clauses, WP_Comment_Query $query )

Since
3.1.0
Filters the comment query clauses.

Compatibility

WordPress
since 3.1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$clausesstring[]
{ Associative array of the clauses for the query.
@type string $fields The SELECT clause of the query.
@type string $join The JOIN clause of the query.
@type string $where The WHERE clause of the query.
@type string $orderby The ORDER BY clause of the query.
@type string $limits The LIMIT clause of the query.
@type string $groupby The GROUP BY clause of the query.
}
  • $fieldsstring

    The SELECT clause of the query.
  • $joinstring

    The JOIN clause of the query.
  • $wherestring

    The WHERE clause of the query.
  • $orderbystring

    The ORDER BY clause of the query.
  • $limitsstring

    The LIMIT clause of the query.
  • $groupbystring

    The GROUP BY clause of the query.
$queryWP_Comment_Query
Current instance of WP_Comment_Query (passed by reference).

Where this hook fires · 1

  • wp-includes/class-wp-comment-query.php:942WP_Comment_Query::get_comment_ids()

Source code

		 *     @type string $orderby  The ORDER BY clause of the query.		 *     @type string $limits   The LIMIT clause of the query.		 *     @type string $groupby  The GROUP BY clause of the query.		 * }		 * @param WP_Comment_Query $query   Current instance of WP_Comment_Query (passed by reference).		 */		$clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) ); 		$fields  = isset( $clauses['fields'] ) ? $clauses['fields'] : '';		$join    = isset( $clauses['join'] ) ? $clauses['join'] : '';		$where   = isset( $clauses['where'] ) ? $clauses['where'] : '';		$orderby = isset( $clauses['orderby'] ) ? $clauses['orderby'] : '';		$limits  = isset( $clauses['limits'] ) ? $clauses['limits'] : '';

Changelog

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.