Updating/Cropping Images via Rest API

[apermo]

At the current moment it is not possible to update an attachment via the rest API, so if using the WordPress Crop Image functionality, there is no way to update the existing media.

I discussed this at WCEU in Belgrade with Mike Schroder. This was obviously simply forgotten.

[joemcgill]

I'd like to see these actions be supported by the REST API. The functionality can mirror wp_ajax_image_editor(), generally and would allow us to build new interfaces on top of the REST API rather than AJAX callbacks, and extend that ability to other clients.

[azaozz]

​https://github.com/WordPress/gutenberg/blob/master/lib/class-wp-rest-image-editor-controller.php is ready for adding to trunk. Works with the current image editor in the block editor (the JS for it is already in).

Porting the edit image endpoint from [Gutenberg](​https://github.com/WordPress/gutenberg/blob/21709e3c533e78f9e63c583b6109caadc7cdf7be/lib/class-wp-rest-image-editor-controller.php).

This is a WIP, working on adding tests. One question I had was the descriptions of the request args, I did my best to add them based on my understanding of how the endpoint works, but that might not be accurate.

Cc: @ajlende.

Trac ticket: https://core.trac.wordpress.org/ticket/44405

Looks good, just one small nitpick :)

Will also need to verify that $image_meta is actually for the same image as it is retrieved by using the attachment ID that is hard-coded in post_content. (Can patch that in trunk. There is another patch that needs the same and will have to make a new function.)

Should we be checking against upload_is_user_over_quota @azaozz?

Should we be checking against upload_is_user_over_quota

Possibly, but seems better to let the user edit the image, and decide if they should delete the parent image? Users can get over the quota even when uploading a large image that creates many sub-sizes...

Possibly, but seems better to let the user edit the image, and decide if they should delete the parent image? Users can get over the quota even when uploading a large image that creates many sub-sizes...

Gotcha. I'll leave it alone for now then.

This works for me testing against the latest Gutenberg. It still doesn't work alone on trunk since the JS in trunk is still expecting the old endpoint.

[TimothyBlynJacobs]

In 48291:

REST API: Introduce endpoint for editing images.

To facilitate inline image editing in Gutenberg, a new endpoint at wp/v2/media/<id>/edit has been introduced. This is functionally similar to the existing ajax image editor, however the REST API editor creates a new attachment record instead of updating an existing attachment.

Fixes #44405.
Props ajlende, ellatrix, spacedmonkey, azaozz.

[azaozz]

In 48518:

REST API, Media: Fix/improve the inline docs and name of the new wp_edited_image_metadata filter.

Props desrosj, azaozz.

See #44405.

[justinahinon]

Related devnotes:
​https://make.wordpress.org/core/2020/07/20/editing-images-in-the-block-editor/
​https://make.wordpress.org/core/2020/07/16/new-and-modified-rest-api-endpoints-in-wordpress-5-5/