class Block

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Block/Attribute/Block.php \Drupal\Core\Block\Attribute\Block
  2. 11.x core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
  3. 10 core/lib/Drupal/Core/Block/Attribute/Block.php \Drupal\Core\Block\Attribute\Block
  4. 10 core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
  5. 8.9.x core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block

Defines a Block annotation object.

Hierarchy

Expanded class hierarchy of Block

Related topics

Annotations
Annotations for class discovery and metadata description.
28 string references to 'Block'
aggregator_help in core/modules/aggregator/aggregator.module
Implements hook_help().
BlockManager::getType in core/lib/Drupal/Core/Block/BlockManager.php
A string identifying the plugin type.
BlockManagerTest::setUp in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php
book.schema.yml in core/modules/book/config/schema/book.schema.yml
core/modules/book/config/schema/book.schema.yml
book_help in core/modules/book/book.module
Implements hook_help().

... See full list

11 classes are annotated with Block
ActiveTopicsBlock in core/modules/forum/src/Plugin/Block/ActiveTopicsBlock.php
Provides an 'Active forum topics' block.
AggregatorFeedBlock in core/modules/aggregator/src/Plugin/Block/AggregatorFeedBlock.php
Provides an 'Aggregator feed' block with the latest items from the feed.
BookNavigationBlock in core/modules/book/src/Plugin/Block/BookNavigationBlock.php
Provides a 'Book navigation' block.
Broken in core/lib/Drupal/Core/Block/Plugin/Block/Broken.php
Defines a fallback plugin for missing block plugins.
FieldBlock in core/modules/layout_builder/tests/modules/layout_builder_fieldblock_test/src/Plugin/Block/FieldBlock.php
Provides test field block to test with Block UI.

... See full list

File

core/lib/Drupal/Core/Block/Annotation/Block.php, line 14

Namespace

Drupal\Core\Block\Annotation
View on git.drupalcode.org
View source 
class Block extends Plugin {
  
  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;
  
  /**
   * The administrative label of the block.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $admin_label = '';
  
  /**
   * The category in the admin UI where the block will be listed.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category = '';
  
  /**
   * An array of context definitions describing the context used by the plugin.
   *
   * The array is keyed by context names.
   *
   * @var \Drupal\Core\Annotation\ContextDefinition[]
   */
  public $context_definitions = [];

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Block::$admin_label public property The administrative label of the block.
Block::$category public property The category in the admin UI where the block will be listed.
Block::$context_definitions public property An array of context definitions describing the context used by the plugin.
Block::$id public property The plugin ID.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.