• Documentation >
• Guide >
• Search >
• Aggregation reference >
• UserMetadataTermAggregation

UserMetadataTermAggregation

The UserMetadataTermAggregation aggregates search results by the User Content item's metadata.

Arguments

• name - name of the Aggregation object

Example

$query = new Query();
$query->aggregations[] = new Aggregation\UserMetadataTermAggregation('user_metadata');

Settings

You can define additional limits to the results using the setLimit() and setMinCount() methods. The following example limits the number of terms returned to 5 and only considers terms that have 10 or more results:

$aggregation = new //...
$aggregation->setLimit(5);
$aggregation->setMinCount(10);