PHPackages                             pixelpoems/silverstripe-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. pixelpoems/silverstripe-search

ActiveSilverstripe-vendormodule[Search & Filtering](/categories/search)

pixelpoems/silverstripe-search
==============================

Silverstripe Search-Module including loading search results js api requests.

2.0.1(2mo ago)1459↓33.3%BSD-3-ClausePHPPHP ^8.3

Since Aug 30Pushed 2mo ago2 watchersCompare

[ Source](https://github.com/pixelpoems/silverstripe-search)[ Packagist](https://packagist.org/packages/pixelpoems/silverstripe-search)[ RSS](/packages/pixelpoems-silverstripe-search/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (9)Dependencies (3)Versions (11)Used By (0)

Silverstripe Search Module
==========================

[](#silverstripe-search-module)

[![stability-beta](https://camo.githubusercontent.com/36eced06ca8bf4d0320406cbe1eacb0dbca16e6726c978d54c184e7676204dee/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73746162696c6974792d626574612d3333626266662e737667)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)

This module provides a silverstripe search using ajax and configurable indexing. You can use it in combination with Silverstripe [Elemental](https://github.com/silverstripe/silverstripe-elemental)and [Fluent](https://github.com/tractorcow-farm/silverstripe-fluent). For Elemental and Fluent configuration check the specified documentation below.

Table of Contents
-----------------

[](#table-of-contents)

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
    - [Inline Search](#inline-search)
    - [Search Page](#search-page)
- [Configuration](#configuration)
    - [Basic Configuration](#basic-configuration)
    - [Available Config Variables](#available-config-variables)
    - [Customizing Index Data](#customizing-index-data)
    - [Populate Task](#populate-task)
- [Advanced Configuration](#advanced-configuration)
    - [Enable Search on DataObjects](#enable-search-on-dataobjects)
    - [Elemental Integration](#elemental-integration)
    - [Fluent Integration](#fluent-integration)
    - [Toggle Configuration for Inline Search](#toggle-configuration-for-inline-search)
- [Customization](#customization)
    - [Overwrite Template Files](#overwrite-template-files)
    - [Modify Search Results](#modify-search-results)
- [Reporting Issues](#reporting-issues)
- [Credits](#credits)

Requirements
------------

[](#requirements)

- Silverstripe CMS ^6.0
- Silverstripe Framework ^6.0

Installation
------------

[](#installation)

```
composer require pixelpoems/silverstripe-search

```

This module includes:

- `Populate Search Task` - Task to create or update the search index
- `Search Page` - Separate Search Page
- `Inline Search` - Template Include

---

Usage
-----

[](#usage)

### Inline Search

[](#inline-search)

This module includes an inline search. The listing within the inline search will display up to ten search results and a "See more..." item which navigates to the search page which will display all search results in a list.

Include the InlineSearch Template within your template:

```

```

### Search Page

[](#search-page)

A dedicated search page is automatically created when you install this module. Users can access it to view all search results in a full-page layout.

---

Configuration
-------------

[](#configuration)

### Basic Configuration

[](#basic-configuration)

Without any special configurations, all pages and subclasses of page which have the "Show in Search" checkbox checked will be indexed. For indexing, you have to run the `PopulateSearch` Task (More details: [Populate Task](#populate-task)).

The following variables can be used to configure your search index:

```
Pixelpoems\Search\Services\SearchConfig:
  index_keys: # Default keys which will be populated within the json index file
    - title # Title will be added by default if nothing else is defined
    - content # Additional index key
```

Those keys are only for separating data within the index (more or less for your own structure - these keys won't be displayed in the search result!). The search prioritizes the content based on the keys - `title` has the first priority in this case and is therefore also displayed first in the result.

By default, your index file is named `index.json` and will be placed at `/search/` within your project root directory. Add `/search` to your `.gitignore` to prevent index files from being pushed to your git repository.

### Available Config Variables

[](#available-config-variables)

Every config can be made via the `Pixelpoems\Search\Services\SearchConfig` class:

NameDefaultDescriptionenable\_default\_style`true`Enable default CSS stylesindex\_keys`['title']`Keys to be indexed in the searchenable\_fluent`false`Enable Fluent localization supportexclude\_locale\_from\_index`[]`Locales to exclude from indexingenable\_elemental`false`Enable Elemental blocks supportexclude\_elements\_from\_index`[]`Element classes to exclude from indexingmax\_results\_inline`10`Maximum results shown in inline searchenable\_toggle\_sm`true`Enable toggle button on small screensenable\_toggle\_lg`false`Enable toggle button on large screenssm\_lg\_breakpoint`768`Breakpoint in pixels for small/large screensExample configuration:

```
---
Name: my-search-config
---

Pixelpoems\Search\Services\SearchConfig:
  enable_default_style: false # Disables default styles
  index_keys:
    - title
    - content
  enable_fluent: true
  exclude_locale_from_index:
    - 'de_AT'
    - 'de_DE'
  enable_elemental: true
  exclude_elements_from_index:
    - 'Namespace\Elements\Element'
  max_results_inline: 10
```

### Customizing Index Data

[](#customizing-index-data)

To update or set the index keys based on the Class, you can extend the Class and use the following method to set the values. If you set extra values here, they won't get noticed by the js logic. Only the predefined keys will be recognized. `$data` will contain all preconfigured keys.

```
public function updateSearchIndexData(array &$data)
{
    $data['content'] = $this->owner->Content;
}
```

To update the data without extension e.g. on a new PageType you can add the following function to your new Page Type with your custom list, which should be indexed:

```
public function getList()
{
    return DataObject::get();
}

public function addSearchData($data)
{
    $tags[] = $this->getList()->map()->values();

    // Make sure other tags do not get overwritten by this function
    if($data['tags']) $data['tags'] = array_merge($data['tags'], $tags);
    else $data['tags'] = $tags;

    return $data;
}
```

To add multiple values e.g. Tags or something similar you can do like this:

```
public function addSearchData($data)
{
    $tags = [];

    // Add Name of an HasOne relation
    if($this->HasOneID) {
        $tags[] = $this->HasOne()->Name;
    }

    // Add Names of an HasMany relations
    if($this->HasMany()->exists()) {
        foreach ($this->HasMany() as $item) {
            $tags[] = $item->Name;
        }
    }

    // Make sure other tags do not get overwritten by this function
    if($data['tags']) $data['tags'] = array_merge($data['tags'], $tags);
    else $data['tags'] = $tags;

    return $data;
}
```

You can use the `SearchService::escapeHTML($string)` function to escape your content before adding it to the index.

### Populate Task

[](#populate-task)

To create or update the search index use the "Search Populate" Task:

`/dev/tasks/Pixelpoems-Search-Tasks-PopulateSearch`

```
vendor/bin/sake tasks:Pixelpoems-Search-Tasks-PopulateSearch
```

This Task will create based on your configuration an `index.json` and an `index-elemental.json` (if elemental is enabled) or `locale.json` and `locale-elemental.json` (if fluent is enabled).

You can extend the search population and add additional Data like that:

```
Pixelpoems\Search\Services\PopulateService:
  extensions:
    - Namespace\PopulateSearchExtension
```

```
public function populateAdditionalData($pageIndexFileName, $locale, &$additionalData)
{
    $dataObjects = ClassInfo::subclassesFor(DataObject::class);
    foreach ($dataObjects as $dataObject) {
        $additionalData = $this->owner->getData($dataObject, $locale);

        // If you want to add some additional Filters to the request you can do it like this
        // $additionalData = $this->owner->getData($dataObject, $locale, ['isActive' => true]);

        $this->owner->log('Data Entities (DataObject / '. $dataObject . '): ' . count($additionalData));

        // Add your additional data to the given array to return this data!
        $additionalData = array_merge($additionalData, $additionalData);
    }

    $this->owner->log($pageIndexFileName . "\n");
}
```

Your Data will be saved within `index.json` or `locale.json`

ATTENTION: Make sure your DataObject has a Link function, so that it can be linked within the search result.

If you want to populate custom data without an DataObject you can add a "link" key to your custom array:

```
public function populateAdditionalData($pageIndexFileName, $locale, &$additionalData)
{
    $additionalData[] = [
        'title' => 'Title',
        'id' => 123456789, # Make sure to add an identifier here
        'content' => 'Content',
        'link' => '/link-to-your-site',
    ];

    $this->owner->log($pageIndexFileName . "\n");
}
```

This will generate a custom Array Data with your context - in the ideal case the array contains the keys `id`, `link` and your defined `index_keys`.

---

Advanced Configuration
----------------------

[](#advanced-configuration)

### Enable Search on DataObjects

[](#enable-search-on-dataobjects)

If you want to add data of a DataObject, you can add text like described in the [Configuration](#configuration) section when indexing a page or an element. Here you can add e.g. the `title` and `content` within the index process of a single page along with all other objects.

```
public function addSearchData($data)
{
    $data = [];

    foreach (DataObject::get() as $dataObject) {
        $data[] = $dataObject->Title . ' '. $dataObject->Content;
    }

    $data['dataObjects'] = implode(' ', $data);

    return $data;
}
```

### Elemental Integration

[](#elemental-integration)

To enable indexing of Elemental blocks, add the following to your configuration yml:

```
Pixelpoems\Search\Services\SearchConfig:
  enable_elemental: true
```

Furthermore, you can use `exclude_elements_from_index` to prevent specific Element classes from being indexed:

```
Pixelpoems\Search\Services\SearchConfig:
  exclude_elements_from_index:
    - Namespace\Elements\Element
```

And add the `SearchIndexExtension` to the Base Element Model:

```
DNADesign\Elemental\Models\BaseElement:
  extensions:
    - Pixelpoems\Search\Extensions\SearchIndexExtension
```

After adding the extension, you can use the `updateSearchIndexData` hook to specify your index data.

#### Enable Virtual Element Indexing

[](#enable-virtual-element-indexing)

If you use Virtual Elements from DNADesign and you want to index the Connected Data for this element, you can add the following Extension to the base "ElementVirtual" Class. This will handle the default indexing with the "Linked Element" data:

```
DNADesign\ElementalVirtual\Model\ElementVirtual:
  extensions:
    - Pixelpoems\Search\Extensions\ElementVirtualExtension
```

### Fluent Integration

[](#fluent-integration)

To enable Fluent localization within the index and search process, add the following to your configuration yml:

```
Pixelpoems\Search\Services\SearchConfig:
  enable_fluent: true
```

If you enabled Fluent through the config, the `Populate Search Task` will create an index file for every locale. To prevent a locale from being indexed, you can add the Locale title within the static variable `exclude_locale_from_index` like this:

```
Pixelpoems\Search\Services\SearchConfig:
  exclude_locale_from_index:
    - 'de_AT'
    - 'de_DE'
```

By default, your index files are named `{locale}.json`, e.g. `de_AT.json`.

### Toggle Configuration for Inline Search

[](#toggle-configuration-for-inline-search)

The inline search can be configured to show/hide the search bar with a toggle button based on screen size. This is useful for responsive designs where you want to save space on smaller screens.

The toggle behavior is controlled by three configuration options:

```
Pixelpoems\Search\Services\SearchConfig:
  enable_toggle_sm: true  # Enable toggle on small screens (below breakpoint)
  enable_toggle_lg: false # Enable toggle on large screens (above breakpoint)
  sm_lg_breakpoint: 768   # Breakpoint in pixels for small/large screens
```

- `enable_toggle_sm`: When `true`, the search bar will be hidden by default on small screens (below the breakpoint) and a toggle button will appear to show/hide it.
- `enable_toggle_lg`: When `true`, the search bar will be hidden by default on large screens (above the breakpoint) and a toggle button will appear to show/hide it.
- `sm_lg_breakpoint`: The screen width in pixels that defines the boundary between small and large screens (default: 768px).

Example configurations:

```
# Show toggle button only on mobile devices
Pixelpoems\Search\Services\SearchConfig:
  enable_toggle_sm: true
  enable_toggle_lg: false
  sm_lg_breakpoint: 768
```

```
# Show toggle button on all screen sizes
Pixelpoems\Search\Services\SearchConfig:
  enable_toggle_sm: true
  enable_toggle_lg: true
  sm_lg_breakpoint: 768
```

```
# Disable toggle functionality (search always visible)
Pixelpoems\Search\Services\SearchConfig:
  enable_toggle_sm: false
  enable_toggle_lg: false
```

To use the toggle configuration, make sure to include the `$SearchToggleAttr` in your inline search template if you overwrite it:

```

    .....

```

---

Customization
-------------

[](#customization)

### Overwrite Template Files

[](#overwrite-template-files)

To overwrite the default search templates you can create a `Pixelpoems/Search` folder within your project templates.

- `Pixelpoems/Search/Ajax/SearchResultList.ss` for the rendered Search result.
- `Pixelpoems/Search/Includes/InlineSearch.ss` for inline Search output.
- `Pixelpoems/Search/Pages/Layout/SearchPage.ss` for your custom Search Page.

*ATTENTION: If you overwrite the templates, make sure that the required js files are included within the templates or will be included via a Controller and the CSS Classes and IDs are there as well. Make sure that the inline search is wrapped within an element with the classes `search-holder inline-search-holder` and within a `search-holder` class on the search page template!*

If you need additional Variables within your Ajax Search Result List Template `Pixelpoems/Search/Ajax/SearchResultList.ss` you can extend the `Pixelpoems/Search/Controllers/SearchController` and update the data with the following hook:

```
public function updateAjaxTemplateData(&$data)
{
    $additionalList = ArrayList::create();
    $data['AdditionalBool'] = true;
    $data['AdditionalList'] = $additionalList
}
```

All the variables that are added here can be accessed in your custom `Ajax/SearchList.ss`.

### Modify Search Results

[](#modify-search-results)

There are multiple hooks to modify the search result before sending the generated list to the template.

Add an extension to SearchService:

```
Pixelpoems\Search\Services\SearchService:
  extensions:
    - Namespace\Extensions\SearchServiceExtension
```

#### Modify List BEFORE Limiting Result

[](#modify-list-before-limiting-result)

Use the hook `updateSearchResultBeforeLimit` for instance to filter the results on a specific Multisite if you use e.g. :

```
public function updateSearchResultBeforeLimit(&$list): void
{
    $currentSiteID = Multisites::inst()->getCurrentSiteId();
    $list = $list->filter(['SiteID' => $currentSiteID]);
}
```

The limitation of the list (for Inline Search) will be added after the hook.

#### Modify List AFTER Limiting Result

[](#modify-list-after-limiting-result)

Use the hook `updateSearchResultAfterLimit` for instance to filter the results after the limitation has been added to the list:

```
public function updateSearchResultAfterLimit(&$list): void
{
    // Do some extra filter or attachment here
}
```

This hook will only be called on a request that is made by the inline search!

If you want to modify the result after limitation for inline search AND on the Search page, use the hook `updateSearchResult`:

```
public function updateSearchResult(&$list): void
{
    // Do some extra filter or attachment here
}
```

---

Reporting Issues
----------------

[](#reporting-issues)

Please [create an issue](https://github.com/pixelpoems/silverstripe-search/issues) for any bugs you've found, or features you're missing.

Credits
-------

[](#credits)

Search and Close icons from Feather Icons -

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance84

Actively maintained with recent releases

Popularity17

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 92.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~113 days

Recently: every ~61 days

Total

9

Last Release

82d ago

Major Versions

1.1.0 → 2.0.02025-06-25

1.2.1 → 2.0.12026-02-25

PHP version history (2 changes)1.0.0PHP >=7.4

2.0.0PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b45ea1277a7072f51fde6587ca46092d1ac996734aed8e085f2b3481742fe3f?d=identicon)[pixelpoems](/maintainers/pixelpoems)

---

Top Contributors

[![BettinaMaria98](https://avatars.githubusercontent.com/u/50010683?v=4)](https://github.com/BettinaMaria98 "BettinaMaria98 (118 commits)")[![andreassp](https://avatars.githubusercontent.com/u/2562181?v=4)](https://github.com/andreassp "andreassp (10 commits)")

---

Tags

searchsilverstripe

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/pixelpoems-silverstripe-search/health.svg)

```
[![Health](https://phpackages.com/badges/pixelpoems-silverstripe-search/health.svg)](https://phpackages.com/packages/pixelpoems-silverstripe-search)
```

###  Alternatives

[silverstripe/solr

Solr integration for SilverStripe. Note that this is NOT related to the silverstripe/fulltext package.

1914.0k](/packages/silverstripe-solr)[g4b0/searchable-dataobjects

This module adds DataObjects to frontend search

254.9k](/packages/g4b0-searchable-dataobjects)[silverstripe-terraformers/gridfield-rich-filter-header

Rich filter header component for GridField

1325.7k1](/packages/silverstripe-terraformers-gridfield-rich-filter-header)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)