Add get_item_schema function to WP_REST_Widget_Areas_Controller

[jorgefilipecosta]

Description

Fixes: #15902

This PR implements the get_item_schema function for WP_REST_Widget_Areas_Controller class.

This fixes a problem where warnings were being displayed during wp-cli usage.
Props to @n9yty, @TimothyBJacobs, and @lkraav for providing valuable information that allowed this fix.

How has this been tested?

I executed wp CLI shell again a WordPress instance running Gutenberg master. Using wp shell --path=/MY/WP/PATH
I verified no error were thrown on master I got:
Warning: Invalid argument supplied for foreach() in /Users/pc/dev/core/wordpres-develop/build/wp-includes/rest-api/endpoints/class-wp-rest-controller.php on line 287
Warning: Invalid argument supplied for foreach() in /Users/pc/dev/core/wordpres-develop/build/wp-includes/rest-api/endpoints/class-wp-rest-controller.php on line 287

[TimothyBJacobs]

Since the endpoint now has a schema, the args should ideally be provided by ::get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ) when registering the update_item route.

[aduth]

@TimothyBJacobs Would you be able to give a fresh review here after the latest changes?

[TimothyBJacobs]

The schema looks good to me, but the register_rest_route call should use that schema for the $args option when registering the edit route. This can be done by calling $this→get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ).

[jorgefilipecosta]

Hi @TimothyBJacobs thank you for the feedback your suggestion was applied 👍

[TimothyBJacobs]

@jorgefilipecosta I think there is an issue with the update_item method call. The code only accounts for when content is a string, but it should also check whether it is an object with the raw property.

$sidebar_content = $request->get_param( 'content' );

An example from the posts controller.

if ( is_string( $request['content'] ) ) {
	$prepared_post->post_content = $request['content'];
} elseif ( isset( $request['content']['raw'] ) ) {
	$prepared_post->post_content = $request['content']['raw'];
}

[TimothyBJacobs]

@jorgefilipecosta Do you want me to push the changes up for this?

[jorgefilipecosta]

Hi @TimothyBJacobs sorry for the delay I had some AFK days, I will soon update this PR.

[jorgefilipecosta]

Hi @TimothyBJacobs, thank you for the review. The issue identified was fixed.
We now handle the raw property for content.
It is possible to test this using the following code:

wp.apiFetch({
    path: '/__experimental/widget-areas/sidebar-1',
    data: { content: { raw: '<!-- wp:columns --><div class="wp-block-columns has-2-columns"><!-- wp:column --><div class="wp-block-column"><!-- wp:paragraph --><p>1</p><!-- /wp:paragraph --></div><!-- /wp:column --><!-- wp:column --><div class="wp-block-column"><!-- wp:paragraph --><p>2</p><!-- /wp:paragraph --></div><!-- /wp:column --></div><!-- /wp:columns -->' } },
    method: 'POST',
}).then(console.log);

Suggestions were applied.

[TimothyBJacobs]

Looks good to me!