Replace deprecated `who` argument from user query

[grappler]

What problem does this address?

In WordPress 5.9 the who argument has been deprecated. Trac Ticket

Gutenberg is still using the who argument and recommending it to be used.

gutenberg/packages/editor/src/components/post-author/constants.js

Line 2 in 08cf4a9

who: 'authors',

gutenberg/packages/block-library/src/avatar/user-control.js

Line 11 in 23f11a1

who: 'authors',

gutenberg/packages/block-library/src/query/edit/inspector-controls/author-control.js

Line 15 in 08cf4a9

who: 'authors',

gutenberg/packages/block-library/src/post-author/edit.js

Line 43 in 760815a

authors: getUsers( { who: 'authors' } ),

gutenberg/packages/core-data/README.md

Line 26 in 711ea0e

return select( 'core' ).getUsers( { who: 'authors' } );

What is your proposed solution?

My suggestion would be to use the capability argument. The following code snippet fetches the edit_post capability for the current post type. This code is only compatible with WordPress 5.9. Either Gutenberg will need to increase the minimum supported version or include a check and a fallback with who: 'authors'.

const AUTHORS_QUERY = {
	per_page: 50,
	_fields: 'id,name',
	context: 'edit', // Allows non-admins to perform requests.
};
const currentPostType = wp.data.select('core/editor').getCurrentPostType();
const editPostCap = wp.data.select('core').getPostType( currentPostType ).capabilities.edit_post;
wp.data.select('core').getUsers( { ...AUTHORS_QUERY, capability: [ editPostCap ] } );

So that everyone does not have to figure out the edit_post capability, it might be best to create a helper function. Though in WordPress 5.9 the getAuthors function was deprecated #33725

Related Issues: #39035 & #17364

[ocean90]

Noting that the current request already generates a X-WP-DeprecatedParam header for this:

X-WP-DeprecatedParam: WP_User_Query (since 5.9.0; <code>who</code> is deprecated. Use <code>capability</code> instead.)

@TimothyBJacobs @spacedmonkey @youknowriad Do you have some ideas how we can detect whether who or capability should be used?

[TimothyBJacobs]

I'm not sure what the progress is on the client having knowledge of the REST API schemas, cc @youknowriad. But the best way would be to look at the schema for the endpoint and check for the presence of the capability property in the GET args.

[grappler]

The only reason that I can see why we would need to check for the support is to be able to run the Gutenberg plugin on WordPress 5.8. Depending on the time it takes for a patch, WordPress 6.0 will have been released.

It might make more sense to increase the minimum required WP version.

gutenberg/gutenberg.php

Line 6 in 956a836

* Requires at least: 5.8

[ocean90]

As of #41306 the plugin now requires 5.9 so I guess we can switch the query to use capability now.

[Mamaduka]

The user's controller has special permission handling for 'authors' === $request['who'], which allows editors to render the authors' selection for low-capability users. We need to keep that in mind when making the change.

https://github.com/WordPress/wordpress-develop/blob/3f9317c2aa2ba650c0d930acaca1bb840c95a6da/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php#L236-L251

Somewhat related - https://core.trac.wordpress.org/ticket/56429.

[apermo]

I just ran into this issue. I was asked to create a new role for guest authors, so basically a user that will never log in, but shall be selected by the editors to show in the frontend.
I read that granting the role edit_posts should be enough for the custom role to appear. After entering the rabbit hole I ended up here.

I'm now at a point where I either will have to add a user lvl of at least 1, in order to satisfy the deprecated filter, or alter the User Query, which might be incompatible with future updates.

TLDR: Sticking with the who parameter has implications that you cannot easily add custom roles to the "Select Author Input" in Gutenberg.

Example code:

add_role(
	'guest_author',
	'Guest Author',
	[
		'read' => true,
		'edit_posts' => true,
		'publish_posts' => true,
	]
);

Create new User with the given role, try to find it in "Author".

Props to @zaphir for helping me find the issue.