public function ConfigurablePropertyInterface::getFieldDescription in Search API 8

Retrieves the description for a field based on this property.

Parameters

\Drupal\search_api\Item\FieldInterface $field: The field.

Return value

string|null A human-readable description for the field, or NULL if the field has no description.

1 method overrides ConfigurablePropertyInterface::getFieldDescription()

ConfigurablePropertyBase::getFieldDescription in src/Processor/ConfigurablePropertyBase.php

Retrieves the description for a field based on this property.

File

src/Processor/ConfigurablePropertyInterface.php, line 72

Class

ConfigurablePropertyInterface

Represents a processor-defined property with additional configuration.

Namespace

Drupal\search_api\Processor

Code

public function getFieldDescription(FieldInterface $field);