WP_Comment_Query::__construct( string|array $query = '' )

Description

Parameters

$querystring|arrayoptional

Array or query string of comment query parameters. Default empty.Default: ''

• $author_emailstringdefault: empty

  Comment author email address.

• $author_urlstringdefault: empty

  Comment author URL.

• $author__inint[]default: empty

  Array of author IDs to include comments for.

• $author__not_inint[]default: empty

  Array of author IDs to exclude comments for.

• $comment__inint[]default: empty

  Array of comment IDs to include.

• $comment__not_inint[]default: empty

  Array of comment IDs to exclude.

• $countbooldefault: false

  Whether to return a comment count (true) or array of comment objects (false).

• $date_queryarraydefault: null

  Date query clauses to limit comments by. See WP_Date_Query.

• $fieldsstringdefault: empty

  Comment fields to return. Accepts 'ids' for comment IDs only or empty for all fields.

• $include_unapprovedarraydefault: empty

  Array of IDs or email addresses of users whose unapproved comments will be returned by the query regardless of $status.

• $karmaintdefault: empty

  Karma score to retrieve matching comments for.

• $meta_keystring|string[]

  Meta key or keys to filter by.

• $meta_valuestring|string[]

  Meta value or values to filter by.

• $meta_comparestring

  MySQL operator used for comparing the meta value. See WP_Meta_Query::<strong>construct() for accepted values and default value.

• $meta_compare_keystring

  MySQL operator used for comparing the meta key. See WP_Meta_Query::</strong>construct() for accepted values and default value.

• $meta_typestring

  MySQL data type that the meta_value column will be CAST to for comparisons. See WP_Meta_Query::<strong>construct() for accepted values and default value.

• $meta_type_keystring

  MySQL data type that the meta_key column will be CAST to for comparisons. See WP_Meta_Query::__construct() for accepted values and default value.

• $meta_queryarray

  An associative array of WP_Meta_Query arguments. See WP_Meta_Query::</strong>construct() for accepted values.

• $numberintdefault: empty (no limit)

  Maximum number of comments to retrieve.

• $pagedintdefault: 1

  When used with $number, defines the page of results to return. When used with $offset, $offset takes precedence.

• $offsetintdefault: 0

  Number of comments to offset the query. Used to build LIMIT clause.

• $no_found_rowsbooldefault: true

  Whether to disable the SQL_CALC_FOUND_ROWS query.

• $orderbystring|arraydefault: 'comment_date_gmt'

  Comment status or array of statuses. To use 'meta_value' or 'meta_value_num', $meta_key must also be defined. To sort by a specific $meta_query clause, use that clause's array key. Accepts: - 'comment_agent' - 'comment_approved' - 'comment_author' - 'comment_author_email' - 'comment_author_IP' - 'comment_author_url' - 'comment_content' - 'comment_date' - 'comment_date_gmt' - 'comment_ID' - 'comment_karma' - 'comment_parent' - 'comment_post_ID' - 'comment_type' - 'user_id' - 'comment__in' - 'meta_value' - 'meta_value_num' - The value of $meta_key - The array keys of $meta_query - false, an empty array, or 'none' to disable ORDER BY clause.

• $orderstringdefault: 'DESC'

  How to order retrieved comments. Accepts 'ASC', 'DESC'.

• $parentintdefault: empty

  Parent ID of comment to retrieve children of.

• $parent__inint[]default: empty

  Array of parent IDs of comments to retrieve children for.

• $parent__not_inint[]default: empty

  Array of parent IDs of comments <em>not</em> to retrieve children for.

• $post_author__inint[]default: empty

  Array of author IDs to retrieve comments for.

• $post_author__not_inint[]default: empty

  Array of author IDs <em>not</em> to retrieve comments for.

• $post_idintdefault: 0

  Limit results to those affiliated with a given post ID.

• $post__inint[]default: empty

  Array of post IDs to include affiliated comments for.

• $post__not_inint[]default: empty

  Array of post IDs to exclude affiliated comments for.

• $post_authorintdefault: empty

  Post author ID to limit results by.

• $post_statusstring|string[]default: empty

  Post status or array of post statuses to retrieve affiliated comments for. Pass 'any' to match any value.

• $post_typestring|string[]default: empty

  Post type or array of post types to retrieve affiliated comments for. Pass 'any' to match any value.

• $post_namestringdefault: empty

  Post name to retrieve affiliated comments for.

• $post_parentintdefault: empty

  Post parent ID to retrieve affiliated comments for.

• $searchstringdefault: empty

  Search term(s) to retrieve matching comments for.

• $statusstring|arraydefault: 'all'

  Comment statuses to limit results by. Accepts an array or space/comma-separated list of 'hold' (comment_status=0), 'approve' (comment_status=1), 'all', or a custom comment status.

• $typestring|string[]default: empty

  Include comments of a given type, or array of types. Accepts 'comment', 'pings' (includes 'pingback' and 'trackback'), or any custom type string.

• $type__instring[]default: empty

  Include comments from a given array of comment types.

• $type__not_instring[]default: empty

  Exclude comments from a given array of comment types.

• $user_idintdefault: empty

  Include comments for a specific user ID.

• $hierarchicalbool|stringdefault: false

  Whether to include comment descendants in the results. - 'threaded' returns a tree, with each comment's children stored in a children property on the WP_Comment object. - 'flat' returns a flat array of found comments plus their children. - Boolean false leaves out descendants. The parameter is ignored (forced to false) when $fields is 'ids' or 'counts'. Accepts 'threaded', 'flat', or false.

• $cache_domainstringdefault: is 'core'

  Unique cache key to be produced when this query is stored in an object cache.

• $update_comment_meta_cachebooldefault: true

  Whether to prime the metadata cache for found comments.

• $update_comment_post_cachebooldefault: false

  Whether to prime the cache for comment posts.

Uses · 1

• WP_Comment_Query::query()Sets up the WordPress query for retrieving comments.

Used by · 9

• WP_REST_Comments_Controller::get_items()Retrieves a list of comment items.
• build_comment_query_vars_from_block()Helper function that constructs a comment query vars array from the passed block properties.
• comments_template()Loads the comment template specified in $file.
• get_approved_comments()Retrieves the approved comments for a post.
• get_comments()Retrieves a list of comments.
• get_page_of_comment()Calculates what page number a comment will appear on for comment paging.
• render_block_core_comment_template()Renders the `core/comment-template` block on the server.
• render_block_core_comments_pagination_next()Renders the `core/comments-pagination-next` block on the server.
• render_block_core_comments_pagination_numbers()Renders the `core/comments-pagination-numbers` block on the server.

Source

View on Trac ↗View on GitHub ↗

273	public function __construct( $query = '' ) {274		$this->query_var_defaults = array(275			'author_email'              => '',276			'author_url'                => '',277			'author__in'                => '',278			'author__not_in'            => '',279			'include_unapproved'        => '',280			'fields'                    => '',281			'ID'                        => '',282			'comment__in'               => '',283			'comment__not_in'           => '',284			'karma'                     => '',285			'number'                    => '',286			'offset'                    => '',287			'no_found_rows'             => true,288			'orderby'                   => '',289			'order'                     => 'DESC',290			'paged'                     => 1,291			'parent'                    => '',292			'parent__in'                => '',293			'parent__not_in'            => '',294			'post_author__in'           => '',295			'post_author__not_in'       => '',296			'post_ID'                   => '',297			'post_id'                   => 0,298			'post__in'                  => '',299			'post__not_in'              => '',300			'post_author'               => '',301			'post_name'                 => '',302			'post_parent'               => '',303			'post_status'               => '',304			'post_type'                 => '',305			'status'                    => 'all',306			'type'                      => '',307			'type__in'                  => '',308			'type__not_in'              => '',309			'user_id'                   => '',310			'search'                    => '',311			'count'                     => false,312			'meta_key'                  => '',313			'meta_value'                => '',314			'meta_query'                => '',315			'date_query'                => null, // See WP_Date_Query.316			'hierarchical'              => false,317			'cache_domain'              => 'core',318			'update_comment_meta_cache' => true,319			'update_comment_post_cache' => false,320		);321 322		if ( ! empty( $query ) ) {323			$this->query( $query );324		}325	}

History

Introduced in 5.3.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, 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.