Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Block/BlockManager.php \Drupal\Core\Block\BlockManager
- 9 core/lib/Drupal/Core/Block/BlockManager.php \Drupal\Core\Block\BlockManager
Manages discovery and instantiation of block plugins.
@todo Add documentation to this class.
Hierarchy
- class \Drupal\Core\Block\BlockManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Core\Block\BlockManagerInterface, FallbackPluginManagerInterface uses CategorizingPluginManagerTrait, FilteredPluginManagerTrait
Expanded class hierarchy of BlockManager
See also
\Drupal\Core\Block\BlockPluginInterface
1 file declares its use of BlockManager
- BlockManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Block/ BlockManagerTest.php
1 string reference to 'BlockManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses BlockManager
File
- core/
lib/ Drupal/ Core/ Block/ BlockManager.php, line 21
Namespace
Drupal\Core\BlockView source
class BlockManager extends DefaultPluginManager implements BlockManagerInterface, FallbackPluginManagerInterface {
use CategorizingPluginManagerTrait {
getSortedDefinitions as traitGetSortedDefinitions;
}
use FilteredPluginManagerTrait;
/**
* The logger.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* Constructs a new \Drupal\Core\Block\BlockManager object.
*
* @param \Traversable $namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to invoke the alter hook with.
* @param \Psr\Log\LoggerInterface $logger
* The logger.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, LoggerInterface $logger) {
parent::__construct('Plugin/Block', $namespaces, $module_handler, 'Drupal\\Core\\Block\\BlockPluginInterface', Block::class, 'Drupal\\Core\\Block\\Annotation\\Block');
$this
->alterInfo($this
->getType());
$this
->setCacheBackend($cache_backend, 'block_plugins');
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
protected function getType() {
return 'block';
}
/**
* {@inheritdoc}
*/
public function processDefinition(&$definition, $plugin_id) {
parent::processDefinition($definition, $plugin_id);
$this
->processDefinitionCategory($definition);
}
/**
* {@inheritdoc}
*/
public function getSortedDefinitions(array $definitions = NULL) {
// Sort the plugins first by category, then by admin label.
$definitions = $this
->traitGetSortedDefinitions($definitions, 'admin_label');
// Do not display the 'broken' plugin in the UI.
unset($definitions['broken']);
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getFallbackPluginId($plugin_id, array $configuration = []) {
return 'broken';
}
/**
* {@inheritdoc}
*/
protected function handlePluginNotFound($plugin_id, array $configuration) {
$this->logger
->warning('The "%plugin_id" was not found', [
'%plugin_id' => $plugin_id,
]);
return parent::handlePluginNotFound($plugin_id, $configuration);
}
}