function hook_plugin_filter_TYPE_alter

Alter the filtering of plugin definitions for a specific plugin type.

TYPE (e.g. "block", "layout") limits hook scope to a plugin type. For example, HOOK_plugin_filter_block_alter() would be invoked by a hook listener which specifies the 'block' plugin list, e.g., BlockLibraryController or ChooseBlockController.

Parameters

\Drupal\Component\Plugin\Definition\PluginDefinitionInterface[]|array[] $definitions: The array of plugin definitions.

mixed[] $extra: An associative array containing additional information provided by the code requesting the filtered definitions.

string $consumer: A string identifying the consumer of these plugin definitions.

Related topics

File

core/lib/Drupal/Core/Plugin/plugin.api.php, line 29

Code

function hook_plugin_filter_TYPE_alter(array &$definitions, array $extra, $consumer) {
    // Remove the "Help" block from the Block UI list.
    if ($consumer == 'block_ui') {
        unset($definitions['help_block']);
    }
    // If the theme is specified, remove the branding block from the Bartik theme.
    if (isset($extra['theme']) && $extra['theme'] === 'bartik') {
        unset($definitions['system_branding_block']);
    }
    // Remove the "Main page content" block from everywhere.
    unset($definitions['system_main_block']);
}