Problem/Motivation

Search is being removed from core. #3581109: Move HelpSearch to Search sub-module moved the search plugin but not the help text about how it should be configured.

Steps to reproduce

Proposed resolution

Move the help text about help search to search_help module.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

LLM disclosure

LLM was used to identify this remaining bit and to create the MR. It is human reviewed and adjusted though.

CommentFileSizeAuthor
#22 Screenshot 2026-08-20 at 07.09.27.png722.25 KBgábor hojtsy
#22 Screenshot 2026-08-20 at 07.09.59.png682.57 KBgábor hojtsy
#21 After.png35.79 KBquietone
#17 Screenshot From 2026-08-11 06-43-48.png469.81 KBlarowlan
#14 screencapture-mr16562-nfmmkobxcva30fg9hmb4dgcbyxlgapoh-tugboatqa-admin-help-search-2026-08-10-10_37_39.png1.24 MBgábor hojtsy

Issue fork drupal-3614983

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

gábor hojtsy created an issue. See original summary.

gábor hojtsy opened merge request !16562

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Issue summary: View changes
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Active » Needs review
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Title: Move help text explaining how to enable help search into the search module » Move help text explaining how to enable help search into the search_help module
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Issue summary: View changes
smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Changes LGTM but appears to have phpcs/phpstan issues.

https://git.drupalcode.org/project/drupal/-/jobs/11356995
https://git.drupalcode.org/project/drupal/-/jobs/11356994

sjpagan made their first commit to this issue’s fork.

sjpagan’s picture

sjpagan commented

PHPCS was just indentation in the switch block. PHPStan was three missing imports: RouteMatchInterface, Url and StringTranslationTrait. Both jobs pass now on pipeline 913692, along with everything else.

Ran the tests locally on the same commit: search_help gives 3 tests / 109 assertions, help gives 27 tests / 11633 assertions.

I also checked hook_help output on a real site. Without search_help installed, the text about configuring help search isn't there; with it installed, search_help provides it. The help module output is identical either way.

Two Functional Javascript jobs failed on the first run and passed on retry. One of them was the console error already tracked in #3472624.

sjpagan’s picture

sjpagan commented
Status: Needs work » Needs review
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Needs review » Reviewed & tested by the community

Even though its my issue, I think @sjpagan contributed significant enough (including manual testing) that I am safe to RTBC :) Also in reference to @smustgrave liking it in #7.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Needs work

Comments on the MR, unfortunately it doesn't work

sjpagan’s picture

sjpagan commented
Status: Needs work » Needs review

@larowlan Applied your suggestion. RemoveHook alone leaves the help module without a hook_help implementation, so /admin/help/help returns 404. The method also needs #[Hook('help', module: 'help')]: it replaces HelpHooks::help(), calls it, and appends the section on help.page.help.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new screencapture-mr16562-nfmmkobxcva30fg9hmb4dgcbyxlgapoh-tugboatqa-admin-help-search-2026-08-10-10_37_39.png1.24 MB

Good find! Configuring help search is now visible (tried with current tugboat preview). I think its a pain that it needs to be done this way but if we want to match this instead of removing, it needs to be done :) The search field already shows up once this module is enabled too. I think this is RTBC though if we want to keep this bit of help instead of removing it.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Needs review

Are we happy with the order change? In HEAD Configuring search pages is the last section, in the screenshot in #14 it is now first?

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Needs review » Reviewed & tested by the community

Wait that's a different screenshot, testing on tugboat instead

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Issue summary: View changes
StatusFileSize
new Screenshot From 2026-08-11 06-43-48.png469.81 KB

Confirming the order and appearance is correct, screenshot

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Needs work

Left a comment on the test

sjpagan’s picture

sjpagan commented
Status: Needs work » Needs review

quietone made their first commit to this issue’s fork.

quietone’s picture

quietone commented
Issue summary: View changes
StatusFileSize
new After.png35.79 KB

I'd like to avoid a functional test with only 1 assertion so I merged the two test methods into one and then the setUp function could be removed. I also tweak the addition of the new section so that it is in the same data list. This avoid a blank line before 'Configuring help search' as in the below screenshot.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Screenshot 2026-08-20 at 07.09.59.png682.57 KB
new Screenshot 2026-08-20 at 07.09.27.png722.25 KB

Looks good to me in code. Also manually tried in the tugboat preview and the help text did not show without Search Help:

It did show when I installed Search Help:

Thanks folks for resolving the outstanding concerns, I think this is good to go :)

  • catch committed 6166c474 on 11.x 
    task: #3614983 Move help text explaining how to enable help search into...

  • catch committed a748fd63 on main 
    task: #3614983 Move help text explaining how to enable help search into...
catch’s picture

catch
he/him
Primary language English
commented
Version: main » 11.x-dev
Status: Reviewed & tested by the community » Fixed

This is a bit more complicated than I'd expect but I see why... Committed/pushed to main and 11.x, thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.