1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Plugin
  7. \
  8. FilteredPluginManagerInterface

FilteredPluginManagerInterface

interface FilteredPluginManagerInterface implements PluginManagerInterface (View source)

Provides an interface for plugin managers that allow filtering definitions.

Methods

mixed
getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

from  DiscoveryInterface
array
getDefinitions()

Gets the definition of all plugins for this type.

from  DiscoveryInterface
bool
hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

from  DiscoveryInterface
object
createInstance(string $plugin_id, array $configuration = [])

Creates a pre-configured instance of a plugin.

from  FactoryInterface
object|false
getInstance(array $options)

Gets a preconfigured instance of a plugin.

from  MapperInterface
PluginDefinitionInterface[]|array[]
getFilteredDefinitions(string $consumer, ContextInterface[]|null $contexts = NULL, array $extra = [])

Gets the plugin definitions for a given type and consumer and filters them.

Details

in DiscoveryInterface at line 28
mixed getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

Parameters

string $plugin_id

A plugin id.
bool $exception_on_invalid

(optional) If TRUE, an invalid plugin ID will throw an exception.

Return Value

mixed

A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is FALSE.

Exceptions

PluginNotFoundException

in DiscoveryInterface at line 39
array getDefinitions()

Gets the definition of all plugins for this type.

Return Value

array

An array of plugin definitions (empty array if no definitions were found). Keys are plugin IDs.

See also

FilteredPluginManagerInterface::getFilteredDefinitions

in DiscoveryInterface at line 50
bool hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

Parameters

string $plugin_id

A plugin ID.

Return Value

bool

TRUE if the definition exists, FALSE otherwise.

in FactoryInterface at line 24
object createInstance(string $plugin_id, array $configuration = [])

Creates a pre-configured instance of a plugin.

Parameters

string $plugin_id

The ID of the plugin being instantiated.
array $configuration

An array of configuration relevant to the plugin instance.

Return Value

object

A fully configured plugin instance.

Exceptions

PluginException

in MapperInterface at line 28
object|false getInstance(array $options)

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.

at line 34
PluginDefinitionInterface[]|array[] getFilteredDefinitions(string $consumer, ContextInterface[]|null $contexts = NULL, array $extra = [])

Gets the plugin definitions for a given type and consumer and filters them.

This allows modules and themes to alter plugin definitions at runtime, which is useful for tasks like hiding specific plugins from a particular user interface.

Parameters

string $consumer

A string identifying the consumer of these plugin definitions.
ContextInterface[]|null $contexts

(optional) Either an array of contexts to use for filtering, or NULL to not filter by contexts.
array $extra

(optional) An associative array containing additional information provided by the code requesting the filtered definitions.

Return Value

PluginDefinitionInterface[]|array[]

An array of plugin definitions that are filtered.

See also

hook_plugin_filter_TYPE_alter()
hook_plugin_filter_TYPE__CONSUMER_alter()