Building a search page isn’t as straight forward as you’d think. At first a client will want something which users can search content, then they may want to modify the search results or even change the ranking of certain content. Long story short, something you thought would be as simple as enabling a module, ends up taking twice as long.
If you need to create custom search pages in Drupal 7, more often than not, you use Search API or create a search page using Views. But the core Search module for Drupal 8 has become more powerful than in Drupal 7. One of the big changes, for site builders, in Drupal 8 is the ability to create custom search pages.
However, there’re a few limitations to creating a search page. First, it’ll have a prefix of “search/” in front but the full URL can be changed by creating a URL alias. Second, you can only adjust the content ranking on these pages. If you want to index extra fields or remove ones from being indexed, you’ll still need Search API to do this.
In this tutorial, you’ll learn how to create a custom search page and how to modify the search results by overriding a template.
Just make sure you’ve installed Drupal using the Standard installation profile. By using the Standard profile, it’ll automatically install and configure the core Search module.
If you’re using the Minimal profile, then you’ll need to install the Search module manually.
Generating Test Content
It’s useful to have real content indexed while building a search page. If you’re like me, you don’t like to spend too much time creating dummy content only to have it blown away.
So to generate test content, I’ll use the “Devel generate” sub-module which ships with Devel.
Just install the sub-module and then go to Configuration, “Generate content”. Select which content types you want generated and click on Generate.
How to Create a Search Page
1. Go to Configuration, and click on “Search pages” from within the “Search and Metadata” section.
2. Scroll down to the “Search pages” section and from here you can manage the existing pages and create new ones.
3. From the “Search page type” select Content then click on “Add new page”.
4. Enter “Site search” in the Label field and add
site to Path.
Then scroll to the bottom and click on “Add search page”.
5. Once you’re back on the “Search pages” page, you can reorder how they’re displayed.
And, you can set the default page by clicking on the down arrow in the “Operations” column.
Before we can test the search page make sure the site content has been indexed. If it hasn’t then nothing will appear in the search results.
To check the index status, go to the “Search pages” page, the one we’re previously on and look at the “Indexing progress” section.
If you see “0% of the site has been indexed.”, then make sure you index the site, by running cron. It can be ran manually by going to “admin/config/system/cron” and clicking on “Run cron”.
Once indexed you should see “100% of the site has been indexed.”.
How to Search for Content
To access the search page directly go to
/search and you should see all the search pages as tabs. If you’re logged in as an administrator, you’ll see Content, Users and “Site search” (the one we created).
If you’re an anonymous user, by default you won’t see the “Advanced search” field-set and the Users tab. This can be changed by adjusting permissions in Drupal.
So to search for content enter in a keyword into “Enter your keywords” and click search icon.
I mentioned in the last section that certain parts of the search page, i.e., “Advanced search” and the Users tab are only accessible if you have permission.
The Search module comes with three permissions: “Administer search”, “Use advanced search” and “Use search”.
This permission let’s you access the “Search pages” configuration page.
Use advanced search
This permission allows access to the “Advanced search” field-set.
This permission is required to access the search. This permission is granted to anonymous and authenticated users when you use the Standard installation profile.
Where is the Permission for Users Tab?
You may have noticed there’s no specific permission for the Users tab. That’s because there is none. Instead, the “View user information” permission from the User module is used to access the tab. This is a bit confusing and I had to look in the code to see which permission is required to access the tab.
So if you want users to search account profiles, give them the “View user information” permission.
How to Modify Search Results
Sometimes you may want to change the markup that’s rendered in the search results. This can be achieved by overriding a specific template. Just copy over the
search-result.html.twig file which can be found in the Search module or your base theme.
The functionality of the search page can very from site to site. Sometimes the out-of-the-box solution is enough other times it’s not. The core Search module should only be used if you’re happy with what it offers. If you need something custom then you’ll need to build your own page using Views (we’ll look at this in the next tutorial) or Search API.
Q: Nothing appears when I search for something?
Make sure you’ve indexed the content by running cron.
Q: Anonymous users can’t access the advanced search section?
Assign the Anonymous role the “Use advanced search” permission and they’ll have access to the advanced search form.
Q: Can I change the URL to a search page?
Yes. Just create a URL alias for the search page you want to change.