comments_template_query_args filter-hookWP 4.5.0

Usage

add_filter( 'comments_template_query_args', 'wp_kama_comments_template_query_args_filter' );

/**
 * Function for `comments_template_query_args` filter-hook.
 * 
 * @param array $comment_args Array of WP_Comment_Query arguments.
 *
 * @return array
 */
function wp_kama_comments_template_query_args_filter( $comment_args ){

	// filter...
	return $comment_args;
}
$comment_args(array)

Array of WP_Comment_Query arguments.

  • orderby(string|array)
    Field(s) to order by.

  • order(string)
    Order of results. Accepts 'ASC' or 'DESC'.

  • status(string)
    Comment status.

  • include_unapproved(array)
    Array of IDs or email addresses whose unapproved comments will be included in results.

  • post_id(int)
    ID of the post.

  • no_found_rows(true|false)
    Whether to refrain from querying for found rows.

  • update_comment_meta_cache(true|false)
    Whether to prime cache for comment meta.

  • hierarchical(true|false|string)
    Whether to query for comments hierarchically.

  • offset(int)
    Comment offset.

  • number(int)
    Number of comments to fetch.

Changelog

Since 4.5.0 Introduced.

Where the hook is called

comments_template()
comments_template_query_args
wp-includes/comment-template.php 1486
$comment_args = apply_filters( 'comments_template_query_args', $comment_args );

Where the hook is used in WordPress

Usage not found.