WP_REST_Comments_Controller::create_item_permissions_check( WP_REST_Request $request ): true|WP_Error

Parameters

$requestWP_REST_Request

Full details about the request.

Return

true|WP_Error

True if the request has access to create items, error object otherwise.

Hooks fired · 1

One hook fires while WP_REST_Comments_Controller::create_item_permissions_check() runs, in this order:

1. 1
   apply_filters( rest_allow_anonymous_comments )filterline 466 (+22 into the body)

   Filters whether comments can be created via the REST API without authentication.

Uses · 11

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• get_option()Retrieves an option value based on an option name.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_current_user_id()Gets the current user's ID.
• current_user_can()Returns whether the current user has the specified capability.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• get_post()Retrieves post data given a post ID or post object.
• comments_open()Determines whether the current post is open for comments.
• WP_Error::__construct()Initializes the error.
• WP_REST_Comments_Controller::check_read_post_permission()Checks if the post can be read.

Source

View on Trac ↗View on GitHub ↗

444	public function create_item_permissions_check( $request ) {445		if ( ! is_user_logged_in() ) {446			if ( get_option( 'comment_registration' ) ) {447				return new WP_Error(448					'rest_comment_login_required',449					__( 'Sorry, you must be logged in to comment.' ),450					array( 'status' => 401 )451				);452			}453 454			/**455			 * Filters whether comments can be created via the REST API without authentication.456			 *457			 * Enables creating comments for anonymous users.458			 *459			 * @since 4.7.0460			 *461			 * @param bool $allow_anonymous Whether to allow anonymous comments to462			 *                              be created. Default `false`.463			 * @param WP_REST_Request $request Request used to generate the464			 *                                 response.465			 */466			$allow_anonymous = apply_filters( 'rest_allow_anonymous_comments', false, $request );467 468			if ( ! $allow_anonymous ) {469				return new WP_Error(470					'rest_comment_login_required',471					__( 'Sorry, you must be logged in to comment.' ),472					array( 'status' => 401 )473				);474			}475		}476 477		// Limit who can set comment `author`, `author_ip` or `status` to anything other than the default.478		if ( isset( $request['author'] ) && get_current_user_id() !== $request['author'] && ! current_user_can( 'moderate_comments' ) ) {479			return new WP_Error(480				'rest_comment_invalid_author',481				/* translators: %s: Request parameter. */482				sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'author' ),483				array( 'status' => rest_authorization_required_code() )484			);485		}486 487		if ( isset( $request['author_ip'] ) && ! current_user_can( 'moderate_comments' ) ) {488			if ( empty( $_SERVER['REMOTE_ADDR'] ) || $request['author_ip'] !== $_SERVER['REMOTE_ADDR'] ) {489				return new WP_Error(490					'rest_comment_invalid_author_ip',491					/* translators: %s: Request parameter. */492					sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'author_ip' ),493					array( 'status' => rest_authorization_required_code() )494				);495			}496		}497 498		if ( isset( $request['status'] ) && ! current_user_can( 'moderate_comments' ) ) {499			return new WP_Error(500				'rest_comment_invalid_status',501				/* translators: %s: Request parameter. */502				sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'status' ),503				array( 'status' => rest_authorization_required_code() )504			);505		}506 507		if ( empty( $request['post'] ) ) {508			return new WP_Error(509				'rest_comment_invalid_post_id',510				__( 'Sorry, you are not allowed to create this comment without a post.' ),511				array( 'status' => 403 )512			);513		}514 515		$post = get_post( (int) $request['post'] );516 517		if ( ! $post ) {518			return new WP_Error(519				'rest_comment_invalid_post_id',520				__( 'Sorry, you are not allowed to create this comment without a post.' ),521				array( 'status' => 403 )522			);523		}

History

Introduced in 4.7.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/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.