Search Modifiers

Search modifiers can influence the search results by modifying the search query. They can be used to filter, sort or aggregate the search results.

Search modifiers can be added to the search via the addModifier() method of the search object.

$search->addModifier(new ParentIdFilter(1))

Available Search Modifiers

Filters

Modifier	Modifier Category	Description
IdFilter	Basic filters	Filter by element ID
IdsFilter	Basic filters	Filter by multiple element IDs
ExcludeFoldersFilter	Basic filters	Exclude folders from search result
ParentIdsFilter	Tree related filters	Filter by parent ID
PathFilter	Tree related filters	Filter by path (depending on use case for all levels or direct children only and with or without the parent item included)
AssetMetaDataFilter	Asset filters	Filter by asset meta data attribute. The format of the $data which needs to be passed depends on the type of the meta data attribute and is handled by its field definition adapter.
WorkspaceFilter	Workspace related filters	Filter based on the user workspaces and permissions (this query is added to the search by default)

Full Text Search Queries

Modifier	Modifier Category	Description
ElementKeySearch	Full text search	Search by element key like in the studio UI. * can be used for wildcard searches - for example "Car*" to find all items starting with "Car".

Sort Modifiers

Modifier	Modifier Category	Description
OrderByFullPath	Tree related sorting	Order by full path (including element key)

Aggregations

Modifier	Modifier Category	Description
ChildrenCountAggregation	Tree related aggregation	Get children counts for given element IDs.
AssetMetaDataAggregation	Assets	Used for the filters in the asset grid to aggregate the filter options for supported meta data types.

Add your own search modifier

To add a custom search modifier implementation two steps are necessary:

1. Create a new class that implements the Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\ModifierInterface interface. This model class should contain all configurable attributes for the modifier. Take a look at the IdFilter for an example.

2. Create a service to implement the logic behind the modifier and add the AsSearchModifierHandler attribute. The attribute can either be directly added to the method which implements to logic or to a class. If added to a class the ´__invoke` method will be used as the handler.

The implemented method needs exactly two arguments.:

• First argument: the modifier model (see step 1).
• Second argument: SearchModifierContextInterface $context

Take a look at the BasicFilters for an example and the OpenSearch search models documentation for more details about the search models to manipulate the search.