rest_comment_query

Filter Hook

Description

Filters WP_Comment_Query arguments when querying comments via the REST API.

Hook Information

File Location	`wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php` View on GitHub
Hook Type	Filter
Line Number	`283`

Hook Parameters

Type	Name	Description
`array`	`$prepared_args`	Array of arguments for WP_Comment_Query.
`WP_REST_Request`	`$request`	The REST API request.

Usage Examples

Basic Usage

<?php
// Hook into rest_comment_query
add_filter('rest_comment_query', 'my_custom_filter', 10, 2);

function my_custom_filter($prepared_args, $request) {
    // Your custom filtering logic here
    return $prepared_args;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php:283 - How this hook is used in WordPress core

<?php
 278  		 * @link https://developer.wordpress.org/reference/classes/wp_comment_query/
 279  		 *
 280  		 * @param array           $prepared_args Array of arguments for WP_Comment_Query.
 281  		 * @param WP_REST_Request $request       The REST API request.
 282  		 */
 283  		$prepared_args = apply_filters( 'rest_comment_query', $prepared_args, $request );
 284  
 285  		$query        = new WP_Comment_Query();
 286  		$query_result = $query->query( $prepared_args );
 287  
 288  		if ( ! $is_head_request ) {

PHP Documentation

<?php
/**
		 * Filters WP_Comment_Query arguments when querying comments via the REST API.
		 *
		 * @since 4.7.0
		 *
		 * @link https://developer.wordpress.org/reference/classes/wp_comment_query/
		 *
		 * @param array           $prepared_args Array of arguments for WP_Comment_Query.
		 * @param WP_REST_Request $request       The REST API request.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.