You are here

public function ExecutablePluginBase::getConfigDefinition in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Executable/ExecutablePluginBase.php \Drupal\Core\Executable\ExecutablePluginBase::getConfigDefinition()
  2. 9 core/lib/Drupal/Core/Executable/ExecutablePluginBase.php \Drupal\Core\Executable\ExecutablePluginBase::getConfigDefinition()

Gets the definition of a configuration option.

@todo: This needs to go into an interface.

Parameters

string $key: The key of the configuration option to get.

Return value

\Drupal\Core\TypedData\DataDefinitionInterface|false The typed data definition describing the configuration option, or FALSE if the option does not exist.

File

core/lib/Drupal/Core/Executable/ExecutablePluginBase.php, line 47

Class

ExecutablePluginBase
Provides the basic architecture for executable plugins.

Namespace

Drupal\Core\Executable

Code

public function getConfigDefinition($key) {
  $definition = $this
    ->getPluginDefinition();
  if (!empty($definition['configuration'][$key])) {
    return $definition['configuration'][$key];
  }
  return FALSE;
}