W3cubDocs

/WordPress

WP_REST_Attachments_Controller::get_edit_media_item_args()

Gets the request args for the edit item route.

Return

(array)

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

protected function get_edit_media_item_args() {
		return array(
			'rotation' => array(
				'description'      => __( 'The amount to rotate the image clockwise in degrees.' ),
				'type'             => 'integer',
				'minimum'          => 0,
				'exclusiveMinimum' => true,
				'maximum'          => 360,
				'exclusiveMaximum' => true,
			),
			'x'        => array(
				'description' => __( 'As a percentage of the image, the x position to start the crop from.' ),
				'type'        => 'number',
				'minimum'     => 0,
				'maximum'     => 100,
			),
			'y'        => array(
				'description' => __( 'As a percentage of the image, the y position to start the crop from.' ),
				'type'        => 'number',
				'minimum'     => 0,
				'maximum'     => 100,
			),
			'width'    => array(
				'description' => __( 'As a percentage of the image, the width to crop the image to.' ),
				'type'        => 'number',
				'minimum'     => 0,
				'maximum'     => 100,
			),
			'height'   => array(
				'description' => __( 'As a percentage of the image, the height to crop the image to.' ),
				'type'        => 'number',
				'minimum'     => 0,
				'maximum'     => 100,
			),
			'src'      => array(
				'description' => __( 'URL to the edited image file.' ),
				'type'        => 'string',
				'format'      => 'uri',
				'required'    => true,
			),
		);
	}

Changelog

Version Description
5.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_attachments_controller/get_edit_media_item_args