WP_REST_Attachments_Controller::get_edit_media_item_args(): array

Compatibility

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

Return value

array

Performance profile

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

195–210

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What one call costs · 1 distinct outcome

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

Uses · 2

• __()Retrieves the translation of $text.
• WP_REST_Attachments_Controller::get_endpoint_args_for_item_schema()Retrieves the query params for the attachments collection.

Used by · 1

• WP_REST_Attachments_Controller::register_routes()Registers the routes for attachments.

Source code

View on Trac ↗View on GitHub ↗

2269	protected function get_edit_media_item_args() {2270		$args = array(2271			'src'       => array(2272				'description' => __( 'URL to the edited image file.' ),2273				'type'        => 'string',2274				'format'      => 'uri',2275				'required'    => true,2276			),2277			// The `modifiers` param takes precedence over the older format.2278			'modifiers' => array(2279				'description' => __( 'Array of image edits.' ),2280				'type'        => 'array',2281				'minItems'    => 1,2282				'items'       => array(2283					'description' => __( 'Image edit.' ),2284					'type'        => 'object',2285					'required'    => array(2286						'type',2287						'args',2288					),2289					'oneOf'       => array(2290						array(2291							'title'      => __( 'Flip' ),2292							'properties' => array(2293								'type' => array(2294									'description' => __( 'Flip type.' ),2295									'type'        => 'string',2296									'enum'        => array( 'flip' ),2297								),2298								'args' => array(2299									'description' => __( 'Flip arguments.' ),2300									'type'        => 'object',2301									'required'    => array(2302										'flip',2303									),2304									'properties'  => array(2305										'flip' => array(2306											'description' => __( 'Flip direction.' ),2307											'type'        => 'object',2308											'required'    => array(2309												'horizontal',2310												'vertical',2311											),2312											'properties'  => array(2313												'horizontal' => array(2314													'description' => __( 'Whether to flip in the horizontal direction.' ),2315													'type' => 'boolean',2316												),2317												'vertical' => array(2318													'description' => __( 'Whether to flip in the vertical direction.' ),2319													'type' => 'boolean',2320												),2321											),2322										),2323									),2324								),2325							),2326						),2327						array(2328							'title'      => __( 'Rotation' ),2329							'properties' => array(2330								'type' => array(2331									'description' => __( 'Rotation type.' ),2332									'type'        => 'string',2333									'enum'        => array( 'rotate' ),2334								),2335								'args' => array(2336									'description' => __( 'Rotation arguments.' ),2337									'type'        => 'object',2338									'required'    => array(2339										'angle',2340									),2341									'properties'  => array(2342										'angle' => array(2343											'description' => __( 'Angle to rotate clockwise in degrees.' ),2344											'type'        => 'number',2345										),2346									),2347								),2348							),

Changelog

Introduced in 5.5.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-attachments-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.