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

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or error object on failure.

Performance profile

How much work a call to WP_REST_Comments_Controller::delete_item() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

12–63

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

Plugin surface

2 hooks

Third-party callbacks on 'rest_comment_trashable', 'rest_delete_comment' 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

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach cache, serialize, query, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 7 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_REST_Comments_Controller::delete_item() runs, in this order:

1. 1
   apply_filters( rest_comment_trashable )filterline 1060 (+18 into the body)

   Filters whether a comment can be trashed via the REST API.

2. 2
   do_action( rest_delete_comment )actionline 1115 (+73 into the body)

   Fires after a comment is deleted via the REST API.

Uses · 11

• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_delete_comment()Trashes or deletes a comment.
• __()Retrieves the translation of $text.
• wp_trash_comment()Moves a comment to the Trash
• get_comment()Retrieves comment data given a comment ID or comment object.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_REST_Comments_Controller::get_comment()Get the comment, if the ID is valid.
• WP_REST_Comments_Controller::prepare_item_for_response()Prepares a single comment output for response.
• WP_REST_Response::__construct()
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

1042	public function delete_item( $request ) {1043		$comment = $this->get_comment( $request['id'] );1044		if ( is_wp_error( $comment ) ) {1045			return $comment;1046		}1047 1048		$force = isset( $request['force'] ) ? (bool) $request['force'] : false;1049 1050		/**1051		 * Filters whether a comment can be trashed via the REST API.1052		 *1053		 * Return false to disable trash support for the comment.1054		 *1055		 * @since 4.7.01056		 *1057		 * @param bool       $supports_trash Whether the comment supports trashing.1058		 * @param WP_Comment $comment        The comment object being considered for trashing support.1059		 */1060		$supports_trash = apply_filters( 'rest_comment_trashable', ( EMPTY_TRASH_DAYS > 0 ), $comment );1061 1062		$request->set_param( 'context', 'edit' );1063 1064		if ( $force ) {1065			$previous = $this->prepare_item_for_response( $comment, $request );1066			$result   = wp_delete_comment( $comment->comment_ID, true );1067			$response = new WP_REST_Response();1068			$response->set_data(1069				array(1070					'deleted'  => true,1071					'previous' => $previous->get_data(),1072				)1073			);1074		} else {1075			// If this type doesn't support trashing, error out.1076			if ( ! $supports_trash ) {1077				return new WP_Error(1078					'rest_trash_not_supported',1079					/* translators: %s: force=true */1080					sprintf( __( "The comment does not support trashing. Set '%s' to delete." ), 'force=true' ),1081					array( 'status' => 501 )1082				);1083			}1084 1085			if ( 'trash' === $comment->comment_approved ) {1086				return new WP_Error(1087					'rest_already_trashed',1088					__( 'The comment has already been trashed.' ),1089					array( 'status' => 410 )1090				);1091			}1092 1093			$result   = wp_trash_comment( $comment->comment_ID );1094			$comment  = get_comment( $comment->comment_ID );1095			$response = $this->prepare_item_for_response( $comment, $request );1096		}1097 1098		if ( ! $result ) {1099			return new WP_Error(1100				'rest_cannot_delete',1101				__( 'The comment cannot be deleted.' ),1102				array( 'status' => 500 )1103			);1104		}1105 1106		/**1107		 * Fires after a comment is deleted via the REST API.1108		 *1109		 * @since 4.7.01110		 *1111		 * @param WP_Comment       $comment  The deleted comment data.1112		 * @param WP_REST_Response $response The response returned from the API.1113		 * @param WP_REST_Request  $request  The request sent to the API.1114		 */1115		do_action( 'rest_delete_comment', $comment, $response, $request );1116 1117		return $response;1118	}

Changelog

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.