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 531 (+32 into the body)

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

Uses · 12

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• 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_post_type_supports_notes()Check if post type supports notes.
• WP_REST_Comments_Controller::check_read_post_permission()Checks if the post can be read.

Source

View on Trac ↗View on GitHub ↗

499	public function create_item_permissions_check( $request ) {500		$is_note = ! empty( $request['type'] ) && 'note' === $request['type'];501 502		if ( ! is_user_logged_in() && $is_note ) {503			return new WP_Error(504				'rest_comment_login_required',505				__( 'Sorry, you must be logged in to comment.' ),506				array( 'status' => 401 )507			);508		}509 510		if ( ! is_user_logged_in() ) {511			if ( get_option( 'comment_registration' ) ) {512				return new WP_Error(513					'rest_comment_login_required',514					__( 'Sorry, you must be logged in to comment.' ),515					array( 'status' => 401 )516				);517			}518 519			/**520			 * Filters whether comments can be created via the REST API without authentication.521			 *522			 * Enables creating comments for anonymous users.523			 *524			 * @since 4.7.0525			 *526			 * @param bool $allow_anonymous Whether to allow anonymous comments to527			 *                              be created. Default `false`.528			 * @param WP_REST_Request $request Request used to generate the529			 *                                 response.530			 */531			$allow_anonymous = apply_filters( 'rest_allow_anonymous_comments', false, $request );532 533			if ( ! $allow_anonymous ) {534				return new WP_Error(535					'rest_comment_login_required',536					__( 'Sorry, you must be logged in to comment.' ),537					array( 'status' => 401 )538				);539			}540		}541 542		// Limit who can set comment `author`, `author_ip` or `status` to anything other than the default.543		if ( isset( $request['author'] ) && get_current_user_id() !== $request['author'] && ! current_user_can( 'moderate_comments' ) ) {544			return new WP_Error(545				'rest_comment_invalid_author',546				/* translators: %s: Request parameter. */547				sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'author' ),548				array( 'status' => rest_authorization_required_code() )549			);550		}551 552		if ( isset( $request['author_ip'] ) && ! current_user_can( 'moderate_comments' ) ) {553			if ( empty( $_SERVER['REMOTE_ADDR'] ) || $request['author_ip'] !== $_SERVER['REMOTE_ADDR'] ) {554				return new WP_Error(555					'rest_comment_invalid_author_ip',556					/* translators: %s: Request parameter. */557					sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'author_ip' ),558					array( 'status' => rest_authorization_required_code() )559				);560			}561		}562 563		if ( $is_note && ! empty( $request['post'] ) && ! current_user_can( 'edit_post', (int) $request['post'] ) ) {564			return new WP_Error(565				'rest_cannot_create_note',566				__( 'Sorry, you are not allowed to create notes for this post.' ),567				array( 'status' => rest_authorization_required_code() )568			);569		}570 571		$edit_cap = $is_note ? array( 'edit_post', (int) $request['post'] ) : array( 'moderate_comments' );572		if ( isset( $request['status'] ) && ! current_user_can( ...$edit_cap ) ) {573			return new WP_Error(574				'rest_comment_invalid_status',575				/* translators: %s: Request parameter. */576				sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'status' ),577				array( 'status' => rest_authorization_required_code() )578			);

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.9.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.