Block editor: localize search suggestions' post type in LinkControl component (#21377) #58638

petitphp · 2024-02-03T00:11:54Z

What?

Show localized name for post type for suggestions in LinkComponent

Why?

Currently, suggestions are always displayed with their post type in English.

How?

Add a new media search handler to standardize the response shape for all search request in the editor
Add a new REST field label in the search-result schema. This field contains the localized post type name of each item in the response.
Update getVisualTypeName function to use the new label field when displaying suggestions in LinkControl

Testing Instructions

In the WordPress admin, using a custom locale (other than English)

Create a few posts / pages / attachment
In a new post, insert a Button block
Select the link option in the block toolbar and search for suggestion

In the results list, the post type next to each item should be displayed in the correct locale.

Screenshots or screencast

Other notes

If this solution is approved, we'll need to open a trac ticket in Core to add the new media search handler and add the new label field. These changes in the REST are currently polyfilled in this PR.

github-actions · 2024-02-03T00:12:08Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: petitphp <petitphp@git.wordpress.org>
Co-authored-by: MaggieCabrera <onemaggie@git.wordpress.org>
Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: TimothyBJacobs <timothyblynjacobs@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

getdave · 2024-02-06T09:30:15Z

Thank you for the PR. Let's sync up with #58458 as that also has a requirement to improve the Media search results.

MaggieCabrera

Thanks for this PR! It is working as intended for me when testing French and Spanish. I left a few comments and labeled this since it's making REST API changes.

lib/class-wp-rest-media-search-handler-gutenberg.php

lib/rest-api.php

getdave

Thank you for the PR. I left some queries.

lib/compat/wordpress-6.6/class-wp-rest-media-search-handler-gutenberg.php

getdave · 2024-02-12T10:25:44Z

lib/compat/wordpress-6.6/rest-api.php

+ * @param  \WP_REST_Request $request Rest request object.
+ * @return string                    Human-readable label for the search result's post type.
+ */
+function _gutenberg_get_search_result_label_field( $result_object, $field_name, $request ) {


Is it possible to put these functions into a directory/file structure that mirrors the intended Core target files? If it is then it will help when it comes to merge for WP 6.6.

If not then an @core-merge comment explaining how this code should be merged into WP Core for 6.6 would be super helpful.

I've move the new media handler to the intended directory in core.

Regarding the addition of the new label property, I'm not sure how this should be handle. The changes touch existing classes in Core and we would need to copy the existing classes on the wp-includes/rest-api/search folder to do the changes. This seems a lot to me.

I kept the register_rest_field in gutenberg and I added a condition before to check if the field is present or not.

I've opened a PR in Core with the intended changes in the REST API link to this PR WordPress/wordpress-develop#6112. I can move those changes in gutenberg if needed.

I'm going to be unavailable for a few days but will check back in here as soon as I get a chance. Thank you for your work here.

I've opened a PR in Core with the intended changes in the REST API link to this PR WordPress/wordpress-develop#6112. I can move those changes in gutenberg if needed.

The Core PR seems to contain other handlers as well and is still draft.

I think a good option would be to land the Media Search endpoint in Gutenberg first and allow it to stablise there whilst we solicit reviews from Core folks on your Core PR.

It's really great that you have the Core PR up early. Let's see if we can get some eyes on it. I'm going to ping @ellatrix who is Editor Tech Lead for WordPress 6.6 so she is aware.

petitphp · 2024-04-19T17:53:42Z

@getdave I rebased the branch against trunk to fix the conflict and redo manual testing to ensure it still work as expected.

getdave · 2024-04-22T16:11:46Z

On my list to review this week 👍

getdave

Testing this it worked as described. I think it's good to land in Gutenberg and allow it to stabilise.

A few nits which it would be good to clean up first though.

You can then work with WP 6.6 Tech Leads to iterate on getting it merged to Core early in this release cycle.

lib/compat/wordpress-6.6/rest-api.php

lib/compat/wordpress-6.6/rest-api/search/class-wp-rest-media-search-handler.php

packages/block-editor/src/components/link-control/search-item.js

…omponent (WordPress#21377) - Add a new media search handler to standardize the response shape for all search request in the editor - Add a new REST field `label` in the search-result schema. This field contains the localized post type name of each item in the response. - Update `getVisualTypeName` function to use the new `label` field when displaying suggestions in `LinkControl`

…avoid duplicate declarations

petitphp · 2024-05-17T13:44:09Z

@getdave Thanks for the review.

I pushed new commits to address your comments and rebased the branch against trunk.

TimothyBJacobs · 2024-05-20T15:55:19Z

Why are we adding a media search handler?

petitphp · 2024-05-20T17:18:03Z

@TimothyBJacobs This was done to unify the response format sent to the editor when doing a search.

A new field label was added to the search handler to provide a localized version of type/subtype, but we currently use the dedicated REST media endpoint to handle the search, and I didn't want to add a new field related to the editor only for this endpoint.

The default post search handler explicitly excludes the attachment postType, so I thought it was better to introduce a dedicated search handler.

petitphp · 2024-07-01T22:53:06Z

@TimothyBJacobs did you had the time to check my response ?

petitphp requested review from spacedmonkey, getdave and nerrad as code owners February 3, 2024 00:11

getdave added [Feature] Link Editing Link components (LinkControl, URLInput) and integrations (RichText link formatting) [Type] Enhancement A suggestion for improvement. labels Feb 5, 2024

MaggieCabrera added the REST API Interaction Related to REST API label Feb 6, 2024

MaggieCabrera reviewed Feb 6, 2024

View reviewed changes

lib/class-wp-rest-media-search-handler-gutenberg.php Outdated Show resolved Hide resolved

lib/rest-api.php Outdated Show resolved Hide resolved

MaggieCabrera mentioned this pull request Feb 7, 2024

LinkControl: Add support for images in attachment search results #58458

Open

getdave reviewed Feb 12, 2024

View reviewed changes

petitphp mentioned this pull request Feb 14, 2024

Add a label field in the search controller to return localized type for each item WordPress/wordpress-develop#6112

Open

petitphp force-pushed the fix/localized-link-suggestions-posttype branch 2 times, most recently from 38eed78 to 7a383f8 Compare April 15, 2024 20:24

getdave approved these changes Apr 26, 2024

View reviewed changes

getdave added the Needs PHP backport Needs PHP backport to Core label Apr 26, 2024

petitphp added 8 commits May 17, 2024 15:15

Fix fetchLinkSuggestions unit tests

60d5d94

move PHP compat code to dedicated folder

a355c50

add missing case for 'post-format'

7327c64

remove debug code

1fcecc3

move new class in the intended Core directory and use new pattern to …

f971ed0

…avoid duplicate declarations

add icon for media in suggestions list

de5d6d1

improve docblock

88c4b71

petitphp force-pushed the fix/localized-link-suggestions-posttype branch from 8d72d3e to 88c4b71 Compare May 17, 2024 13:35

petitphp mentioned this pull request May 20, 2024

PHP backports for WP 6.6 #61226

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block editor: localize search suggestions' post type in LinkControl component (#21377) #58638

Block editor: localize search suggestions' post type in LinkControl component (#21377) #58638

petitphp commented Feb 3, 2024 •

edited

Loading

github-actions bot commented Feb 3, 2024 •

edited

Loading

getdave commented Feb 6, 2024

MaggieCabrera left a comment

getdave left a comment

getdave Feb 12, 2024

petitphp Feb 14, 2024

getdave Feb 15, 2024

getdave Apr 26, 2024

petitphp commented Apr 19, 2024

getdave commented Apr 22, 2024

getdave left a comment •

edited

Loading

petitphp commented May 17, 2024

TimothyBJacobs commented May 20, 2024

petitphp commented May 20, 2024

petitphp commented Jul 1, 2024

Block editor: localize search suggestions' post type in LinkControl component (#21377) #58638

Are you sure you want to change the base?

Block editor: localize search suggestions' post type in LinkControl component (#21377) #58638

Conversation

petitphp commented Feb 3, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

Screenshots or screencast

Other notes

github-actions bot commented Feb 3, 2024 • edited Loading

getdave commented Feb 6, 2024

MaggieCabrera left a comment

Choose a reason for hiding this comment

getdave left a comment

Choose a reason for hiding this comment

getdave Feb 12, 2024

Choose a reason for hiding this comment

petitphp Feb 14, 2024

Choose a reason for hiding this comment

getdave Feb 15, 2024

Choose a reason for hiding this comment

getdave Apr 26, 2024

Choose a reason for hiding this comment

petitphp commented Apr 19, 2024

getdave commented Apr 22, 2024

getdave left a comment • edited Loading

Choose a reason for hiding this comment

petitphp commented May 17, 2024

TimothyBJacobs commented May 20, 2024

petitphp commented May 20, 2024

petitphp commented Jul 1, 2024

petitphp commented Feb 3, 2024 •

edited

Loading

github-actions bot commented Feb 3, 2024 •

edited

Loading

getdave left a comment •

edited

Loading