WP_REST_Comments_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 15

Every hook that fires from inside WP_REST_Comments_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 1

$metaWP_REST_Comment_Meta_Fieldsprotected

Instance of a comment meta fields object.

Methods · 27

• __construct()Constructor.
• register_routes()Registers the routes for comments.
• get_items_permissions_check()Checks if a given request has access to read comments.
• get_items()Retrieves a list of comment items.
• get_comment()Get the comment, if the ID is valid.
• get_item_permissions_check()Checks if a given request has access to read the comment.
• get_item()Retrieves a comment.
• create_item_permissions_check()Checks if a given request has access to create a comment.
• create_item()Creates a comment.
• update_item_permissions_check()Checks if a given REST request has access to update a comment.
• update_item()Updates a comment.
• delete_item_permissions_check()Checks if a given request has access to delete a comment.
• delete_item()Deletes a comment.
• prepare_item_for_response()Prepares a single comment output for response.
• prepare_links()Prepares links for the request.
• normalize_query_param()Prepends internal property prefix to query parameters to match our response fields.
• prepare_status_response()Checks comment_approved to set comment status for single comment output.
• prepare_item_for_database()Prepares a single comment to be inserted into the database.
• get_item_schema()Retrieves the comment's schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for collections.
• handle_status_param()Sets the comment_status of a given comment object when creating or updating a comment.
• check_read_post_permission()Checks if the post can be read.
• check_read_permission()Checks if the comment can be read.
• check_edit_permission()Checks if a comment can be edited or deleted.
• check_comment_author_email()Checks a comment author email for validity.
• check_is_comment_content_allowed()If empty comments are not allowed, checks if the provided comment content is not empty.
• check_post_type_supports_notes()Check if post type supports notes.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Comments_Controller extends WP_REST_Controller {18 19	/**20	 * Instance of a comment meta fields object.21	 *22	 * @since 4.7.023	 * @var WP_REST_Comment_Meta_Fields24	 */25	protected $meta;26 27	/**28	 * Constructor.29	 *30	 * @since 4.7.031	 */32	public function __construct() {33		$this->namespace = 'wp/v2';34		$this->rest_base = 'comments';35 36		$this->meta = new WP_REST_Comment_Meta_Fields();37	}38 39	/**40	 * Registers the routes for comments.41	 *42	 * @since 4.7.043	 *44	 * @see register_rest_route()45	 */46	public function register_routes() {47 48		register_rest_route(49			$this->namespace,50			'/' . $this->rest_base,51			array(52				array(53					'methods'             => WP_REST_Server::READABLE,54					'callback'            => array( $this, 'get_items' ),55					'permission_callback' => array( $this, 'get_items_permissions_check' ),56					'args'                => $this->get_collection_params(),57				),58				array(59					'methods'             => WP_REST_Server::CREATABLE,60					'callback'            => array( $this, 'create_item' ),61					'permission_callback' => array( $this, 'create_item_permissions_check' ),62					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),63				),64				'schema' => array( $this, 'get_public_item_schema' ),65			)66		);67 68		register_rest_route(69			$this->namespace,70			'/' . $this->rest_base . '/(?P<id>[\d]+)',71			array(72				'args'   => array(73					'id' => array(74						'description' => __( 'Unique identifier for the comment.' ),75						'type'        => 'integer',76					),77				),78				array(79					'methods'             => WP_REST_Server::READABLE,80					'callback'            => array( $this, 'get_item' ),81					'permission_callback' => array( $this, 'get_item_permissions_check' ),82					'args'                => array(83						'context'  => $this->get_context_param( array( 'default' => 'view' ) ),84						'password' => array(85							'description' => __( 'The password for the parent post of the comment (if the post is password protected).' ),86							'type'        => 'string',87						),88					),89				),90				array(91					'methods'             => WP_REST_Server::EDITABLE,92					'callback'            => array( $this, 'update_item' ),93					'permission_callback' => array( $this, 'update_item_permissions_check' ),94					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),95				),96				array(

Changelog

Introduced in 4.7.0. One change between 6.7.7 and 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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.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.