Structured data: Collector

Collects structured data entities from registered providers.

Capabilities and extension points

Structured data module.

• var object

Entities cached by this collector after its first collection.

• var array|null

Creates a collector.

• param object $module Structured data module.

Collects valid entities from supported providers.

The first result is cached for this collector instance. Register providers before collection and create a new collector for a different context. Invalid entries and provider exceptions produce developer diagnostics; other valid providers still contribute.

• param Context $context Structured data request context.
• return array Collected entities keyed by provider and position.

Gets registered providers.

• return array Registered providers.

Adds valid entities returned by a provider.

• param Provider $provider Provider instance.
• param mixed $entities Provider result.

Determines whether an entity follows the provider contract.

• param mixed $entity Proposed schema entity.
• return bool Whether the entity is valid.

Reports an invalid provider registration.

• param mixed $provider Invalid provider.

Reports invalid provider output.

• param Provider $provider Provider instance.

Source reference

This editable reference page is based on the PHP documentation in structured-data/class-collector.php.