3 namespace Drupal\Core\Block;
5 use Drupal\Component\Plugin\FallbackPluginManagerInterface;
6 use Drupal\Core\Cache\CacheBackendInterface;
7 use Drupal\Core\Extension\ModuleHandlerInterface;
8 use Drupal\Core\Plugin\CategorizingPluginManagerTrait;
9 use Drupal\Core\Plugin\Context\ContextAwarePluginManagerTrait;
10 use Drupal\Core\Plugin\DefaultPluginManager;
13 * Manages discovery and instantiation of block plugins.
15 * @todo Add documentation to this class.
17 * @see \Drupal\Core\Block\BlockPluginInterface
19 class BlockManager extends DefaultPluginManager implements BlockManagerInterface, FallbackPluginManagerInterface {
21 use CategorizingPluginManagerTrait {
22 getSortedDefinitions as traitGetSortedDefinitions;
23 getGroupedDefinitions as traitGetGroupedDefinitions;
25 use ContextAwarePluginManagerTrait;
28 * Constructs a new \Drupal\Core\Block\BlockManager object.
30 * @param \Traversable $namespaces
31 * An object that implements \Traversable which contains the root paths
32 * keyed by the corresponding namespace to look for plugin implementations.
33 * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
34 * Cache backend instance to use.
35 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
36 * The module handler to invoke the alter hook with.
38 public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
39 parent::__construct('Plugin/Block', $namespaces, $module_handler, 'Drupal\Core\Block\BlockPluginInterface', 'Drupal\Core\Block\Annotation\Block');
41 $this->alterInfo('block');
42 $this->setCacheBackend($cache_backend, 'block_plugins');
48 public function processDefinition(&$definition, $plugin_id) {
49 parent::processDefinition($definition, $plugin_id);
50 $this->processDefinitionCategory($definition);
56 public function getSortedDefinitions(array $definitions = NULL) {
57 // Sort the plugins first by category, then by label.
58 $definitions = $this->traitGetSortedDefinitions($definitions, 'admin_label');
59 // Do not display the 'broken' plugin in the UI.
60 unset($definitions['broken']);
67 public function getGroupedDefinitions(array $definitions = NULL) {
68 $definitions = $this->traitGetGroupedDefinitions($definitions, 'admin_label');
69 // Do not display the 'broken' plugin in the UI.
70 unset($definitions[$this->t('Block')]['broken']);
77 public function getFallbackPluginId($plugin_id, array $configuration = []) {