You are here

public function FieldsHelperInterface::isFieldIdReserved in Search API 8

Determines whether a field ID is reserved for special use.

We define all field IDs starting with "search_api_" as reserved, to be safe for future additions (and from clashing with backend-defined fields).

Parameters

string $fieldId: The field ID.

Return value

bool TRUE if the field ID is reserved, FALSE if it can be used normally.

1 method overrides FieldsHelperInterface::isFieldIdReserved()
FieldsHelper::isFieldIdReserved in src/Utility/FieldsHelper.php
Determines whether a field ID is reserved for special use.

File

src/Utility/FieldsHelperInterface.php, line 160

Class

FieldsHelperInterface
Provides an interface for implementations of the fields helper service.

Namespace

Drupal\search_api\Utility

Code

public function isFieldIdReserved($fieldId);