PHPackages                             nglasl/silverstripe-extensible-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. nglasl/silverstripe-extensible-search

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

nglasl/silverstripe-extensible-search
=====================================

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

4.1.6(4y ago)030.1k↓100%4[2 PRs](https://github.com/symbiote/silverstripe-extensible-search/pulls)5BSD-3-ClausePHP

Since Aug 20Pushed 2y ago1 watchersCompare

[ Source](https://github.com/symbiote/silverstripe-extensible-search)[ Packagist](https://packagist.org/packages/nglasl/silverstripe-extensible-search)[ Docs](https://github.com/nglasl/silverstripe-extensible-search)[ RSS](/packages/nglasl-silverstripe-extensible-search/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (58)Used By (5)

[extensible search](https://packagist.org/packages/nglasl/silverstripe-extensible-search)
=========================================================================================

[](#extensible-search)

*The current release is **4.1.4***

> This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

Requirement
-----------

[](#requirement)

- SilverStripe 3.1 → **4.0**

Getting Started
---------------

[](#getting-started)

- [Place the module under your root project directory.](https://packagist.org/packages/nglasl/silverstripe-extensible-search)
- Configure the search engine and search form YAML.
- `/dev/build`
- Configure the extensible search page.

Overview
--------

[](#overview)

### Extensible Search Page

[](#extensible-search-page)

This is automatically created, and allows configuration for search based on a search engine (more below).

[![page](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-page.png)](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-page.png)

### Search Engine

[](#search-engine)

The extensible search page is designed to use full-text search out of the box, while providing support for custom search engine implementations (elastic search for example).

#### Full-Text

[](#full-text)

```
SilverStripe\ORM\Search\FulltextSearchable:
  searchable_classes:
    - 'SilverStripe\CMS\Model\SiteTree'
SilverStripe\CMS\Model\SiteTree:
  create_table_options:
    MySQLDatabase: 'ENGINE=MyISAM'
  extensions:
    - "SilverStripe\\ORM\\Search\\FulltextSearchable('Title', 'MenuTitle', 'Content', 'MetaDescription')"
```

When considering the search engine to use, full-text has some important limitations. This configuration can also be applied to `File`, however, unfortunately it does not support further customisation.

#### Custom Search Engine

[](#custom-search-engine)

The following is an example configuration, where `ElasticSearch` extends the abstract `CustomSearchEngine` class:

```
nglasl\extensible\ExtensibleSearchPage:
  custom_search_engines:
    nglasl\extensible\ElasticSearch: 'Elastic'
```

### Search Form

[](#search-form)

```
PageController:
  extensions:
    - 'nglasl\extensible\ExtensibleSearchExtension'
```

Using this, to display the search form that users interact with (from your template):

```
$SearchForm
```

### Search Analytics

[](#search-analytics)

These are important to help determine either popular content on your site, or whether content is difficult for users to locate. They're automatically enabled out of the box, however, can be disabled using the following:

```
nglasl\extensible\ExtensibleSearch:
  enable_analytics: false
```

[![analytics](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-analytics.png)](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-analytics.png)

When triggering a search, appending `?analytics=false` to the URL will bypass the search analytics. This is fantastic for debugging.

#### Archiving

[](#archiving)

Depending on your search traffic, `/dev/tasks/ExtensibleSearchArchiveTask` may be used to archive past search analytics, for each search page. It would be recommended to trigger this on a schedule where possible.

[![archives](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-archives.png)](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-archives.png)

[![archive](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-archive.png)](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-archive.png)

### Search Suggestions

[](#search-suggestions)

These are most effective alongside the search analytics (in which case they're automatically populated), and can be used to display either popular searches on your site, or search form autocomplete options. They're automatically enabled out of the box, however, can be disabled using the following:

```
nglasl\extensible\ExtensibleSearchSuggestion:
  enable_suggestions: false
```

[![suggestions](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-suggestions.png)](https://raw.githubusercontent.com/nglasl/silverstripe-extensible-search/master/client/images/extensible-search-suggestions.png)

To enable autocomplete using the **approved** search suggestions..

```
Requirements::javascript('nglasl/silverstripe-extensible-search: client/javascript/extensible-search-suggestions.js');

// OPTIONAL.

Requirements::css('jquery-ui.min.css');
Requirements::javascript('jquery-ui.min.js');
```

### Smart Templating

[](#smart-templating)

Custom search engine specific templates may be defined for your search results. These are just two examples:

`ElasticSearch_results.ss` or `Page_results.ss`

SS4 Changes
-----------

[](#ss4-changes)

- The custom search engine implementation has changed, and no longer uses extensions (see above).

Maintainer Contact
------------------

[](#maintainer-contact)

```
Nathan Glasl, nathan@symbiote.com.au

```

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity77

Established project with proven stability

 Bus Factor1

Top contributor holds 50% 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 ~45 days

Recently: every ~182 days

Total

57

Last Release

1721d ago

Major Versions

2.1.4 → 3.0.22016-08-03

3.1.12 → 4.0.02017-12-06

3.1.13 → 4.0.12019-07-30

3.1.14 → 4.0.22019-08-25

3.1.x-dev → 4.0.x-dev2021-01-10

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/23506857?v=4)[Symbiote](/maintainers/symbiote)[@symbiote](https://github.com/symbiote)

---

Top Contributors

[![nyeholt](https://avatars.githubusercontent.com/u/161730?v=4)](https://github.com/nyeholt "nyeholt (4 commits)")[![KhushbuFuletra](https://avatars.githubusercontent.com/u/51351463?v=4)](https://github.com/KhushbuFuletra "KhushbuFuletra (2 commits)")[![rodneyway](https://avatars.githubusercontent.com/u/568332?v=4)](https://github.com/rodneyway "rodneyway (1 commits)")[![silbinarywolf](https://avatars.githubusercontent.com/u/3859574?v=4)](https://github.com/silbinarywolf "silbinarywolf (1 commits)")

---

Tags

searchsilverstripefull-text

### Embed Badge

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

```
[![Health](https://phpackages.com/badges/nglasl-silverstripe-extensible-search/health.svg)](https://phpackages.com/packages/nglasl-silverstripe-extensible-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)