WP_REST_Posts_Controller::handle_featured_media( int $featured_media, int $post_id ): bool|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

$featured_mediaint

Featured Media ID.

$post_idint

Post ID.

Return value

bool|WP_Error

Whether the post thumbnail was successfully deleted, otherwise WP_Error.

Performance profile

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

9–20

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()one call below WP_REST_Posts_Controller::handle_featured_media()

Further down the call graph this can also reach hook, serialize, cache, 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 · 3 distinct outcomes

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

Uses · 4

• set_post_thumbnail()Sets the post thumbnail (featured image) for the given post.
• __()Retrieves the translation of $text.
• delete_post_thumbnail()Removes the thumbnail (featured image) from the given post.
• WP_Error::__construct()Initializes the error.

Used by · 3

• WP_REST_Attachments_Controller::handle_featured_media()Determines the featured media based on a request param.
• WP_REST_Posts_Controller::create_item()Creates a single post.
• WP_REST_Posts_Controller::update_item()Updates a single post.

Source code

View on Trac ↗View on GitHub ↗

1578	protected function handle_featured_media( $featured_media, $post_id ) {1579 1580		$featured_media = (int) $featured_media;1581		if ( $featured_media ) {1582			$result = set_post_thumbnail( $post_id, $featured_media );1583			if ( $result ) {1584				return true;1585			} else {1586				return new WP_Error(1587					'rest_invalid_featured_media',1588					__( 'Invalid featured media ID.' ),1589					array( 'status' => 400 )1590				);1591			}1592		} else {1593			return delete_post_thumbnail( $post_id );1594		}1595	}

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 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.