PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-comment-query.php

Comment API: WP_Comment_Query class

File Size:	1246 lines (48 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

WP_Comment_Query:: (11 methods):
  __call()
  __construct()
  parse_query()
  query()
  get_comments()
  get_comment_ids()
  set_found_comments()
  fill_descendants()
  get_search_sql()
  parse_orderby()
  parse_order()

Class: WP_Comment_Query - X-Ref

Core class used for querying comments.

__call( $name, $arguments ) X-Ref

Make private/protected methods readable for backward compatibility.

param: string $name Method to call.
param: array $arguments Arguments to pass when calling.
return: mixed|false Return value of the callback, false otherwise.

__construct( $query = '' ) X-Ref

Constructor.

Sets up the comment query, based on the query vars passed.

param: string|array $query {

parse_query( $query = '' ) X-Ref

Parse arguments passed to the comment query with default query parameters.

param: string|array $query WP_Comment_Query arguments. See WP_Comment_Query::__construct() for accepted arguments.

query( $query ) X-Ref

Sets up the WordPress query for retrieving comments.

param: string|array $query Array or URL query string of parameters.
return: array|int List of comments, or number of comments when 'count' is passed as a query var.

get_comments() X-Ref

Get a list of comments matching the query vars.

return: int|int[]|WP_Comment[] List of comments or number of found comments if `$count` argument is true.

get_comment_ids() X-Ref

Used internally to get a list of comment IDs matching the query vars.

return: int|array A single count of comment IDs if a count query. An array of comment IDs if a full query.

set_found_comments() X-Ref

Populates found_comments and max_num_pages properties for the current
query if the limit clause was used.

fill_descendants( $comments ) X-Ref

Fetch descendants for located comments.

Instead of calling `get_children()` separately on each child comment, we do a single set of queries to fetch
the descendant trees for all matched top-level comments.

param: WP_Comment[] $comments Array of top-level comments whose descendants should be filled in.
return: array

get_search_sql( $search, $columns ) X-Ref

Used internally to generate an SQL string for searching across multiple columns.

param: string $search Search string.
param: string[] $columns Array of columns to search.
return: string Search SQL.

parse_orderby( $orderby ) X-Ref

Parse and sanitize 'orderby' keys passed to the comment query.

param: string $orderby Alias for the field to order by.
return: string|false Value to used in the ORDER clause. False otherwise.

parse_order( $order ) X-Ref

Parse an 'order' query variable and cast it to ASC or DESC as necessary.

param: string $order The 'order' query variable.
return: string The sanitized 'order' query variable.

PHP Cross Reference of WordPress Trunk (Updated Daily)

/wp-includes/ -> class-wp-comment-query.php (summary)

Defines 1 class