Remove constraint that search handlers must return integer ids

[TimothyBlynJacobs]

The WP_REST_Search_Controller currently enforces that the id property returned by WP_REST_Search_Handler::search_items is an integer. AFAICT this constraint isn't required. But it does mean that items that don't have integer ids can't be searched.

A string id isn't uncommon, for example uuids or hashids. But this also causes a particular issue in Gutenberg where we want to ​expose post formats via the API. Ideally the formats would be referred to by their slug, but currently Gutenberg has to create fake ids to satisfy the search controller.

[stoyangeorgiev]

Remove absint from the result ids

[stoyangeorgiev]

I have uploaded a patch where I have removed the absint for the result ids.

[TimothyBlynJacobs]

Thanks for working on a patch @stoyangeorgiev!

There are a couple of other changes we need to make too. The type hints for the $id parameter should be updated to int|string. We'll also need to update the id schema in WP_REST_Search_Controller to be an array of array( 'integer', 'string' ) to reflect that it can be either of those types.

[stoyangeorgiev]

Changed param type and schema type

[stoyangeorgiev]

Hello there @TimothyBlynJacobs,

I have done the changes, you mentioned above. Changed the parameter hint and also added the array of types to the schema.

[TimothyBlynJacobs]

Thanks @stoyangeorgiev!

We also need to do similar doc block updates for WP_REST_Search_Handler.

Could you also open this as a Pull Request? That way we can automatically get tests and linting to run.

​https://github.com/WordPress/wordpress-develop

Removed the constraints in WP_REST_Search_Controller, updated id schema, and updated the docs. Edited the docs for WP_REST_Search_Handler.

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

[stoyangeorgiev]

Hello there @TimothyBlynJacobs,

I have opened a Pull Request and all checks have passed successfully.

[TimothyBlynJacobs]

In 49088:

REST API: Allow for string ids in the search controller.

Previously, the search controller infrastructure required that the id property was an integer. This prevents data models that use a string id from utilizing the search infrastructure.

This commit lifts the restraint that search handlers return integer ids. This will allow for the Post Formats search handler coming in 5.6 to use slugs instead of creating fake ids.

Props stoyangeorgiev.
Fixes #51131.

Fixed in a3eb0d8. Thanks again or the patch @stoyan-g!

[SergeyBiryukov]

In 49089:

Docs: Add @since notes for the $id parameter of REST API search controller accepting a string.

Follow-up to [49088].

See #51131.