class BlockPluginUI

Same name in this branch

Defines an overrideable UI for block selection, configuration, and placement.

Plugin annotation


@Plugin(
  id = "block_plugin_ui",
  module = "block",
  all_plugins = @Translation("All Blocks"),
  config_path = "admin/structure/block/add",
  default_task = TRUE,
  derivative = "Drupal\block\Plugin\Derivative\BlockPluginUI",
  facets = {
    "module" = @Translation("Modules")
  },
  link_title = @Translation("Place block"),
  manager = "plugin.manager.block",
  menu = TRUE,
  path = "admin/structure/block/list",
  suffix = "add",
  task_suffix = "library",
  task_title = @Translation("Library"),
  title = @Translation("Place blocks"),
  title_attribute = "admin_label",
  type = MENU_LOCAL_ACTION
)

Hierarchy

Expanded class hierarchy of BlockPluginUI

File

drupal/core/modules/block/lib/Drupal/block/Plugin/PluginUI/BlockPluginUI.php, line 38

Namespace

Drupal\block\Plugin\PluginUI
View source

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginUI::access public function Overrides \Drupal\system\Plugin\PluginUIBase::access(). Overrides PluginUIBase::access
BlockPluginUI::allPluginsUrl protected function Provides an "all" style link to reset the facets.
BlockPluginUI::facetCompare protected function Determines whether a given facet should be displayed for a plugin.
BlockPluginUI::facetLink protected function Creates a facet link for a given facet of a display plugin.
BlockPluginUI::form public function Overrides \Drupal\system\Plugin\PluginUIBase::form(). Overrides PluginUIBase::form
BlockPluginUI::formSubmit public function Overrides \Drupal\system\Plugin\PluginUIBase::formSubmit(). Overrides PluginUIBase::formSubmit
BlockPluginUI::formValidate public function Overrides \Drupal\system\Plugin\PluginUIBase::formValidate(). Overrides PluginUIBase::formValidate
BlockPluginUI::row public function Overrides \Drupal\system\Plugin\PluginUIBase::row(). Overrides PluginUIBase::row
BlockPluginUI::tableHeader public function Overrides \Drupal\system\Plugin\PluginUIBase::tableHeader(). Overrides PluginUIBase::tableHeader
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 17