WP_Comment_Query

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 6

Every hook that fires from inside WP_Comment_Query, in the order it appears in the class, grouped by the method that fires it.

Properties · 11

$requeststringpublic

SQL for database query.

$meta_queryWP_Meta_Querypublic

Metadata query container

$meta_query_clausesarrayprotected

Metadata query clauses.

$sql_clausesarrayprotected

SQL query clauses.

$filtered_where_clausestringprotected

SQL WHERE clause.

$date_queryWP_Date_Querypublic

Date query container

$query_varsarraypublic

Query vars set by the user.

$query_var_defaultsarraypublic

Default values for query vars.

$commentsint[]|WP_Comment[]public

List of comments located by the query.

$found_commentsintpublic

The amount of found comments for the current query.

$max_num_pagesintpublic

The number of pages.

Methods · 11

• __call()Make private/protected methods readable for backward compatibility.
• __construct()Constructor.
• parse_query()Parse arguments passed to the comment query with default query parameters.
• query()Sets up the WordPress query for retrieving comments.
• get_comments()Get a list of comments matching the query vars.
• get_comment_ids()Used internally to get a list of comment IDs matching the query vars.
• set_found_comments()Populates found_comments and max_num_pages properties for the current query if the limit clause was used.
• fill_descendants()Fetch descendants for located comments.
• get_search_sql()Used internally to generate an SQL string for searching across multiple columns.
• parse_orderby()Parse and sanitize 'orderby' keys passed to the comment query.
• parse_order()Parse an 'order' query variable and cast it to ASC or DESC as necessary.

Source code

View on Trac ↗View on GitHub ↗

17#[AllowDynamicProperties]18class WP_Comment_Query {19 20	/**21	 * SQL for database query.22	 *23	 * @since 4.0.124	 * @var string25	 */26	public $request;27 28	/**29	 * Metadata query container30	 *31	 * @since 3.5.032	 * @var WP_Meta_Query A meta query instance.33	 */34	public $meta_query = false;35 36	/**37	 * Metadata query clauses.38	 *39	 * @since 4.4.040	 * @var array41	 */42	protected $meta_query_clauses;43 44	/**45	 * SQL query clauses.46	 *47	 * @since 4.4.048	 * @var array49	 */50	protected $sql_clauses = array(51		'select'  => '',52		'from'    => '',53		'where'   => array(),54		'groupby' => '',55		'orderby' => '',56		'limits'  => '',57	);58 59	/**60	 * SQL WHERE clause.61	 *62	 * Stored after the {@see 'comments_clauses'} filter is run on the compiled WHERE sub-clauses.63	 *64	 * @since 4.4.265	 * @var string66	 */67	protected $filtered_where_clause;68 69	/**70	 * Date query container71	 *72	 * @since 3.7.073	 * @var WP_Date_Query A date query instance.74	 */75	public $date_query = false;76 77	/**78	 * Query vars set by the user.79	 *80	 * @since 3.1.081	 * @var array82	 */83	public $query_vars;84 85	/**86	 * Default values for query vars.87	 *88	 * @since 4.2.089	 * @var array90	 */91	public $query_var_defaults;92 93	/**94	 * List of comments located by the query.95	 *96	 * @since 4.0.0

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.9.7 tag, from src/wp-includes/class-wp-comment-query.php, 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.