WP_Comment_Query::get_comment_ids(): int|array

Return

int|array

A single count of comment IDs if a count query. An array of comment IDs if a full query.

Hooks fired · 1

One hook fires while WP_Comment_Query::get_comment_ids() runs, in this order:

1. 1
   apply_filters( comments_clauses )filterline 942 (+398 into the body)

   Filters the comment query clauses.

Uses · 10

• wp_parse_list()Converts a comma- or space-separated list of scalar values to an array.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• absint()Converts a value to non-negative integer.
• wp_parse_id_list()Cleans up an array, comma- or space-separated list of IDs.
• wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
• apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
• WP_Comment_Query::parse_orderby()Parse and sanitize 'orderby' keys passed to the comment query.
• WP_Comment_Query::parse_order()Parse an 'order' query variable and cast it to ASC or DESC as necessary.
• WP_Comment_Query::get_search_sql()Used internally to generate an SQL string for searching across multiple columns.
• WP_Date_Query::__construct()Constructor.

Used by · 1

• WP_Comment_Query::get_comments()Get a list of comments matching the query vars.

Source

View on Trac ↗View on GitHub ↗

544	protected function get_comment_ids() {545		global $wpdb;546 547		// Assemble clauses related to 'comment_approved'.548		$approved_clauses = array();549 550		// 'status' accepts an array or a comma-separated string.551		$status_clauses = array();552		$statuses       = wp_parse_list( $this->query_vars['status'] );553 554		// Empty 'status' should be interpreted as 'all'.555		if ( empty( $statuses ) ) {556			$statuses = array( 'all' );557		}558 559		// 'any' overrides other statuses.560		if ( ! in_array( 'any', $statuses, true ) ) {561			foreach ( $statuses as $status ) {562				switch ( $status ) {563					case 'hold':564						$status_clauses[] = "comment_approved = '0'";565						break;566 567					case 'approve':568						$status_clauses[] = "comment_approved = '1'";569						break;570 571					case 'all':572					case '':573						$status_clauses[] = "( comment_approved = '0' OR comment_approved = '1' )";574						break;575 576					default:577						$status_clauses[] = $wpdb->prepare( 'comment_approved = %s', $status );578						break;579				}580			}581 582			if ( ! empty( $status_clauses ) ) {583				$approved_clauses[] = '( ' . implode( ' OR ', $status_clauses ) . ' )';584			}585		}586 587		// User IDs or emails whose unapproved comments are included, regardless of $status.588		if ( ! empty( $this->query_vars['include_unapproved'] ) ) {589			$include_unapproved = wp_parse_list( $this->query_vars['include_unapproved'] );590 591			foreach ( $include_unapproved as $unapproved_identifier ) {592				// Numeric values are assumed to be user IDs.593				if ( is_numeric( $unapproved_identifier ) ) {594					$approved_clauses[] = $wpdb->prepare( "( user_id = %d AND comment_approved = '0' )", $unapproved_identifier );595				} else {596					// Otherwise we match against email addresses.597					if ( ! empty( $_GET['unapproved'] ) && ! empty( $_GET['moderation-hash'] ) ) {598						// Only include requested comment.599						$approved_clauses[] = $wpdb->prepare( "( comment_author_email = %s AND comment_approved = '0' AND {$wpdb->comments}.comment_ID = %d )", $unapproved_identifier, (int) $_GET['unapproved'] );600					} else {601						// Include all of the author's unapproved comments.602						$approved_clauses[] = $wpdb->prepare( "( comment_author_email = %s AND comment_approved = '0' )", $unapproved_identifier );603					}604				}605			}606		}607 608		// Collapse comment_approved clauses into a single OR-separated clause.609		if ( ! empty( $approved_clauses ) ) {610			if ( 1 === count( $approved_clauses ) ) {611				$this->sql_clauses['where']['approved'] = $approved_clauses[0];612			} else {613				$this->sql_clauses['where']['approved'] = '( ' . implode( ' OR ', $approved_clauses ) . ' )';614			}615		}616 617		$order = ( 'ASC' === strtoupper( $this->query_vars['order'] ) ) ? 'ASC' : 'DESC';618 619		// Disable ORDER BY with 'none', an empty array, or boolean false.620		if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {621			$orderby = '';622		} elseif ( ! empty( $this->query_vars['orderby'] ) ) {623			$ordersby = is_array( $this->query_vars['orderby'] ) ?

History

Introduced in 4.4.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.7.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.