You are here

public function PluginManagerBase::getInstance in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Component/Plugin/PluginManagerBase.php \Drupal\Component\Plugin\PluginManagerBase::getInstance()
  2. 10 core/lib/Drupal/Component/Plugin/PluginManagerBase.php \Drupal\Component\Plugin\PluginManagerBase::getInstance()

Gets a preconfigured instance of a plugin.

Parameters

array $options: An array of options that can be used to determine a suitable plugin to instantiate and how to configure it.

Return value

object|false A fully configured plugin instance. The interface of the plugin instance will depend on the plugin type. If no instance can be retrieved, FALSE will be returned.

Overrides MapperInterface::getInstance

7 methods override PluginManagerBase::getInstance()
ArchiverManager::getInstance in core/lib/Drupal/Core/Archiver/ArchiverManager.php
Gets a preconfigured instance of a plugin.
FormatterPluginManager::getInstance in core/lib/Drupal/Core/Field/FormatterPluginManager.php
Overrides PluginManagerBase::getInstance().
MailManager::getInstance in core/lib/Drupal/Core/Mail/MailManager.php
Overrides PluginManagerBase::getInstance().
ResourcePluginManager::getInstance in core/modules/rest/src/Plugin/Type/ResourcePluginManager.php
SelectionPluginManager::getInstance in core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php
Gets a preconfigured instance of a plugin.

... See full list

File

core/lib/Drupal/Component/Plugin/PluginManagerBase.php, line 106

Class

PluginManagerBase
Base class for plugin managers.

Namespace

Drupal\Component\Plugin

Code

public function getInstance(array $options) {
  if (!$this->mapper) {
    throw new \BadMethodCallException(sprintf('%s does not support this method unless %s::$mapper is set.', static::class, static::class));
  }
  return $this->mapper
    ->getInstance($options);
}