PluginHelper.php

Same filename in other branches
  1. 9 core/lib/Drupal/Component/Plugin/PluginHelper.php
  2. 10 core/lib/Drupal/Component/Plugin/PluginHelper.php
  3. 11.x core/lib/Drupal/Component/Plugin/PluginHelper.php

Namespace

Drupal\Component\Plugin

File

core/lib/Drupal/Component/Plugin/PluginHelper.php

View source
<?php

namespace Drupal\Component\Plugin;


/**
 * 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.
 */
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;
    }

}

Classes

Title Deprecated Summary
PluginHelper A helper class to determine if a plugin is configurable.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.