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

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

true|WP_Error

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

Performance profile

How much work a call to WP_REST_Comments_Controller::create_item_permissions_check() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

18–114

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 243.

Plugin surface

1 hook

Third-party callbacks on 'rest_allow_anonymous_comments' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()called directly
• cacheobject cachewp_cache_get()one call below WP_REST_Comments_Controller::create_item_permissions_check()
• serializeserialisationmaybe_unserialize()one call below WP_REST_Comments_Controller::create_item_permissions_check()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 227 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Comments_Controller::create_item_permissions_check() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters 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 · 13

• 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.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• 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_target_post_permission()Checks that a post can receive a comment or a note from the current user.

Source code

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'] ) ) {564			$target_check = $this->check_target_post_permission( (int) $request['post'], $request, true );565 566			if ( is_wp_error( $target_check ) ) {567				return $target_check;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			);

Changelog

Introduced in 4.7.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 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.