Feat: Adds the editing capability to the search title.

[vipul0425]

What?

Fixes issue #60701
This PR adds the editing capability to the search results title block.

Why?

• As mentioned in issue Rename titles - of Search Results Title and Archive Title blocks #60701 the search result title is not editable, so the user can't edit the text for the search results.

How?

• Adds the richtext component to make the title editable.

Testing Instructions

1. Open the Site editor and edit the search template.
2. There you will find the "Search Results Title" Block.
3. You should be able to add and edit the text there.

Testing Instructions for Keyboard

Nil

Screenshots or screencast

compressed.screencast.1.mp4

[github-actions]

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: vipul0425 <[email protected]>
Co-authored-by: anton-vlasenko <[email protected]>
Co-authored-by: t-hamano <[email protected]>
Co-authored-by: jameskoster <[email protected]>
Co-authored-by: paaljoachim <[email protected]>
Co-authored-by: ntsekouras <[email protected]>

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

[github-actions]

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @vipul0425! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

[jameskoster]

First of all, this is a good PR and would be a welcome addition I think. But it does highlight some confusing aspects of this block that we should consider fixing.

Here's what I see in the editor when the 'Show search term' option is toggled off:

The styling of the text and the caret position suggest this is a placeholder, but that's not the case—it appears on the frontend regardless:

---

Contrast that with what you experience when 'Show search term' is toggled on:

Now 'Search results for' and 'suffix' look like placeholders, and indeed that's what they are—they do not appear on the frontend when left empty:

Imo it would be good to fix this inconsistency before merging.

[anton-vlasenko]

Calling isset() is not needed since empty() already checks if the property is set. Calling !empty( $attributes['searchResultsTerm'] ) is equivalent to calling isset( $attributes['searchResultsTerm'] ) && $attributes['searchResultsTerm'].

Suggested change

	$title = isset( $attributes['searchResultsTerm'] ) && ! empty( $attributes['searchResultsTerm'] ) ? $attributes['searchResultsTerm'] : __( 'Search results' );
	$title = ! empty( $attributes['searchResultsTerm'] ) ? $attributes['searchResultsTerm'] : __( 'Search results' );

[vipul0425]

Thanks @anton-vlasenko. I have fixed it in the latest commit 🙇

[vipul0425]

First of all, this is a good PR and would be a welcome addition I think. But it does highlight some confusing aspects of this block that we should consider fixing.

Here's what I see in the editor when the 'Show search term' option is toggled off:

The styling of the text and the caret position suggest this is a placeholder, but that's not the case—it appears on the frontend regardless: Contrast that with what you experience when 'Show search term' is toggled on: Now 'Search results for' and 'suffix' look like placeholders, and indeed that's what they are—they do not appear on the frontend when left empty: Imo it would be good to fix this inconsistency before merging.

Thanks, @jameskoster, for pointing this out. I've addressed the inconsistency in the latest commit.

[t-hamano]

@vipul0425 Thanks for the PR!

I think the important thing here is that the "Archive Title" block and the "Search Results Title" block exist as variations of the block called "Query Title" block. Similarly, the text of the Archive Title block cannot be edited at all.

Is there a request to be able to edit the prefix and suffix text in the Archive Title block as well? If there is, it may be better to avoid adding attribute names that depend on specific variations such as searchResultsTerm and searchResultsTermSuffix. More generic attribute names like prefix and suffix might be useful if we want to apply this approach to the Archive Title block in the future.

Another important point is that the term "Search Results for:" is not guaranteed to appear before the search term in all languages. For example, in Japanese Search results for "%s" is translated as 「%s」の検索結果.

In order to advance this PR, I would be happy if we could have a more detailed discussion and find the ideal approach.

I'll also ping @jorgefilipecosta and @carolinan who have worked on improving this block in the past.

[vipul0425]

Hi @t-hamano,

Thanks for reviewing this. Regarding the "Archive Title," I believe it should be editable, but as there was no request for adding that, I updated only for the Search Title block. I could only find this issue from the past referring to the update in Archive-title #44158.

Regarding using generic terms for prefixes and suffixes, do we want to share the same prefix and suffix across the archive and search title like the showPrefix attribute? I think we should keep them separate though we can club both the prefixes (archive and search title) under a common attribute object like "prefix." Let me know what you think about this.

Thanks for letting me know about "Search Results for:" in different language scenarios. We can use a generic placeholder value like "prefix." Let me know if you have any better suggestions.

Thanks 🙇

[paaljoachim]

Is there a request to be able to edit the prefix and suffix text in the Archive Title block as well? If there is, it may be better to avoid adding attribute names that depend on specific variations such as searchResultsTerm and searchResultsTermSuffix. More generic attribute names like prefix and suffix might be useful if we want to apply this approach to the Archive Title block in the future.

This sounds like a very good idea!
@vipul0425 If you can add the same generic prefix and suffix to the Archive Title block in addition to the Search Results Title block that would be very helpful.

I will update the original issue to reflect a change to both the Search Results Title block and the Archive Title block.

[t-hamano]

Sorry for the late reply. I was thinking of an ideal solution to this problem, but it might be more complicated than I thought 😅

What I think is the ideal approach is as follows:

---

The default state of the block has Prefix and suffix placeholders and displays only the search term.

Users can reproduce the same title by entering text in Prefix and Suffix.

When "Show search term in title" is off, it will display a placeholder with the placeholder "Search results". This is managed internally as the prefix attribute. This placeholder is different from the normal prefix and suffix and is meant to be the default text.

If this approach makes sense, block migration is required to preserve the appearance of existing blocks. We will need to consider the following two patterns:

If "Show search term in title" is enabled

Assign Search results for: “ to the prefix attribute and “ to the suffix attribute.

If "Show search term in title" is disabled

Assign Search results to the prefix attribute.

---

What do you think about this approach?

[paaljoachim]

Hey @t-hamano Aki

Search

This is what I read.

An example
User searches for course.

Default state is when the toggle Show search term in title is on. The Search page will show:

Search results for: “course”

When the toggle search term in title is off. The Search page will show:

Search results

Adding a Prefix to adjust the Search results / Search results for: “ —> will be very helpful.
Adding a Suffix to be able to add text after the search term -> will also be very helpful.

This means.
When the default toggle Show search term in title is on.
One would be able to change Search results for: (Prefix) and “ (Suffix) to example You are looking for course which we offer.

You are looking for -> is then the Prefix.
which we offer. -> is then the Suffix.

When the toggle Show search term in title is off.
One would be able to change the Search results (Prefix) to something else. As the search term is not inserted there is no need for a Suffix.

Conclusion.
When the toggle is on. It uses Prefix and Suffix to be able to add text before and after a specific search term.
When the toggle is off. It would only use the Prefix to add text/title to the Search page.

This sounds like a good approach!

---

Archive title

Default toggle on: Show archive type in title. (Archive type: Name)

Example. A category named course. On the frontend it will show Category: course

Toggle is off. (Archive title)
On the frontend it will then show the category name: course

Since text is automatically inserted when the toggle is on or off.
Be it Category: course or only course it would be helpful to have Prefix and Suffix for both options.

[t-hamano]

When the toggle is off. It would only use the Prefix to add text/title to the Search page.

That's right. Being able to edit only the text is almost the same as the Paragraph block, so I thought about removing the toggle itself, but this specification is for backward compatibility.

Regarding the Archive Title block (variation), it may be a good idea to maintain the current specifications and consider it as a follow-up.

[paaljoachim]

Here is a similar PR: #61920

It is also working on the prefix / suffix. Similar approaches should be done for both PRs.

[t-hamano]

Hi @vipul0425,

The approach I suggested, adding the prefix and suffix, may not be ideal. See #61920 for details.

Sorry for the confusion 🙏

[ntsekouras]

Thanks for the PR! It seems to me we should probably wait a bit for Bits (pun not intended) and see if it can solve this use case too.

I think the important thing here is that the "Archive Title" block and the "Search Results Title" block exist as variations of the block called "Query Title" block. Similarly, the text of the Archive Title block cannot be edited at all.

@t-hamano raised a very good aspect of the block and even made me think what other variations this block could have besides the existing two variations. This block was introduced 3 years ago with only the archive title version and a year after the search variation was added and after that nothing new.. So besides the Bits thing, should we revisit if it makes sense to have variations instead of different blocks? In general it doesn't feel right when we start adding specific attributes for variations, which we already have done.