public function SelectionInterface::getReferenceableEntities in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface::getReferenceableEntities()
2. 9 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface::getReferenceableEntities()

Gets the list of referenceable entities.

Parameters

string|null $match: (optional) Text to match the label against. Defaults to NULL.

string $match_operator: (optional) Operator to be used for string matching. Defaults to "CONTAINS".

int $limit: (optional) Limit the query to a given number of items. Defaults to 0, which indicates no limiting.

Return value

array A nested array of entities, the first level is keyed by the entity bundle, which contains an array of entity labels (escaped), keyed by the entity ID.

1 method overrides SelectionInterface::getReferenceableEntities()

DefaultSelection::getReferenceableEntities in core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/DefaultSelection.php

Gets the list of referenceable entities.

File

core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php, line 34

Class

SelectionInterface

Interface definition for Entity Reference Selection plugins.

Namespace

Drupal\Core\Entity\EntityReferenceSelection

Code

public function getReferenceableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0);