WP_REST_Comments_Controller::create_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

Parameters

$requestWP_REST_Request

Full details about the request.

Return

WP_REST_Response|WP_Error

Response object on success, or error object on failure.

Hooks fired · 3

3 hooks fire while WP_REST_Comments_Controller::create_item() runs, in this order:

1. 1
   apply_filters( rest_pre_insert_comment )filterline 788 (+138 into the body)

   Filters a comment before it is inserted via the REST API.

2. 2
   do_action( rest_insert_comment )actionline 819 (+169 into the body)

   Fires after a comment is created or updated via the REST API.

3. 3
   do_action( rest_after_insert_comment )actionline 850 (+200 into the body)

   Fires completely after a comment is created or updated via the REST API.

Uses · 24

• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• current_time()Retrieves the current time based on specified type.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• wp_get_current_user()Retrieves the current user object.
• get_option()Retrieves an option value based on an option name.
• wp_check_comment_data_max_lengths()Compares the lengths of comment data against the maximum character limits.
• wp_allow_comment()Validates whether this comment is allowed to be made.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_insert_comment()Inserts a comment into the database.
• wp_filter_comment()Filters and sanitizes comment data.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.

Source

View on Trac ↗View on GitHub ↗

650	public function create_item( $request ) {651		if ( ! empty( $request['id'] ) ) {652			return new WP_Error(653				'rest_comment_exists',654				__( 'Cannot create existing comment.' ),655				array( 'status' => 400 )656			);657		}658 659		// Do not allow comments to be created with a non-core type.660		if ( ! empty( $request['type'] ) && ! in_array( $request['type'], array( 'comment', 'note' ), true ) ) {661			return new WP_Error(662				'rest_invalid_comment_type',663				__( 'Cannot create a comment with that type.' ),664				array( 'status' => 400 )665			);666		}667 668		$prepared_comment = $this->prepare_item_for_database( $request );669		if ( is_wp_error( $prepared_comment ) ) {670			return $prepared_comment;671		}672 673		$prepared_comment['comment_type'] = $request['type'];674 675		if ( ! isset( $prepared_comment['comment_content'] ) ) {676			$prepared_comment['comment_content'] = '';677		}678 679		// Include note metadata into check_is_comment_content_allowed.680		if ( isset( $request['meta']['_wp_note_status'] ) ) {681			$prepared_comment['meta']['_wp_note_status'] = $request['meta']['_wp_note_status'];682		}683 684		if ( ! $this->check_is_comment_content_allowed( $prepared_comment ) ) {685			return new WP_Error(686				'rest_comment_content_invalid',687				__( 'Invalid comment content.' ),688				array( 'status' => 400 )689			);690		}691 692		// Setting remaining values before wp_insert_comment so we can use wp_allow_comment().693		if ( ! isset( $prepared_comment['comment_date_gmt'] ) ) {694			$prepared_comment['comment_date_gmt'] = current_time( 'mysql', true );695		}696 697		// Set author data if the user's logged in.698		$missing_author = empty( $prepared_comment['user_id'] )699			&& empty( $prepared_comment['comment_author'] )700			&& empty( $prepared_comment['comment_author_email'] )701			&& empty( $prepared_comment['comment_author_url'] );702 703		if ( is_user_logged_in() && $missing_author ) {704			$user = wp_get_current_user();705 706			$prepared_comment['user_id']              = $user->ID;707			$prepared_comment['comment_author']       = $user->display_name;708			$prepared_comment['comment_author_email'] = $user->user_email;709			$prepared_comment['comment_author_url']   = $user->user_url;710		}711 712		// Honor the discussion setting that requires a name and email address of the comment author.713		if ( get_option( 'require_name_email' ) ) {714			if ( empty( $prepared_comment['comment_author'] ) || empty( $prepared_comment['comment_author_email'] ) ) {715				return new WP_Error(716					'rest_comment_author_data_required',717					__( 'Creating a comment requires valid author name and email values.' ),718					array( 'status' => 400 )719				);720			}721		}722 723		if ( ! isset( $prepared_comment['comment_author_email'] ) ) {724			$prepared_comment['comment_author_email'] = '';725		}726 727		if ( ! isset( $prepared_comment['comment_author_url'] ) ) {728			$prepared_comment['comment_author_url'] = '';729		}

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