class PluginHelper in Drupal 8

A helper class to determine if a plugin is configurable.

Because configurable plugins in Drupal 8 might implement either the deprecated ConfigurablePluginInterface or the new ConfigurableInterface, this static method is provided so that a calling class can determine if a plugin is configurable without checking it against a deprecated interface. In Drupal 9, this check should be reduced to checking for ConfigurableInterface only and be deprecated in favor of calling classes checking against the interface directly.

Hierarchy

• class \Drupal\Component\Plugin\PluginHelper

4 files declare their use of PluginHelper

Action.php in core/modules/system/src/Entity/Action.php

ContextAwarePluginBase.php in core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php

DefaultLazyPluginCollection.php in core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php

DefaultSingleLazyPluginCollection.php in core/lib/Drupal/Core/Plugin/DefaultSingleLazyPluginCollection.php

File

core/lib/Drupal/Component/Plugin/PluginHelper.php, line 16

Namespace

Drupal\Component\Plugin

class PluginHelper {

  /**
   * Determines if a plugin is configurable.
   *
   * @param mixed $plugin
   *   The plugin to check.
   *
   * @return bool
   *   A boolean indicating whether the plugin is configurable.
   */
  public static function isConfigurable($plugin) {
    return $plugin instanceof ConfigurableInterface || $plugin instanceof ConfigurablePluginInterface;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginHelper::isConfigurable	public static	function	Determines if a plugin is configurable.