Last updated: Sep 28 2016

Area: Episerver CMS Applies to versions: 10 and higher
Other versions:

Adding search providers

The global search in the global menu of Episerver features search functionality by aggregating results from several search providers. You can search any type of content, and each provider reports results based on a specific category, such as pages, blog posts, or files.

For Episerver, the following search providers are included:

  • PageSearchProvider searches for CMS pages (including page content).
  • FileSearchProvider searches for CMS documents.
  • BlockSearchProvider searches for blocks.

Using the [SearchProvider] attribute

To add a custom search provider, configure your assembly as a shell module (see Configuring Shell modules). Next, implement the ISearchProvider interface and decorate the class with the [SearchProvider] attribute.


  • Area prioritizes search providers in the current area such that search providers for the CMS area are placed first when performing a search from the edit and admin interfaces.
  • Category is a display name in the user interface.


  • Search returns an enumeration of results for the given query.


    public class FileSearchProvider : ISearchProvider
    /// <summary>
    /// Area that the provider mapps to, used for spotlight searching
    /// </summary>
    public string Area
        get { return "CMS"; }

    /// <summary>
                /// The category that the provider returns hits in
                /// </summary>
                public string Category
        get { return "Files"; }

    public IEnumerable<SearchResult> Search(Query query)
        return ...

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/