1. 8.2.x core/lib/Drupal/Core/Block/Annotation/Block.php Block
  2. 8.2.x core/modules/views/src/Plugin/views/display/Block.php Block
  3. 8.2.x core/modules/block/src/Entity/Block.php Block
  4. 8.2.x core/modules/block/src/Plugin/migrate/source/Block.php Block
  5. 8.0.x core/modules/block/src/Plugin/migrate/source/Block.php Block
  6. 8.0.x core/modules/block/src/Entity/Block.php Block
  7. 8.0.x core/lib/Drupal/Core/Block/Annotation/Block.php Block
  8. 8.0.x core/modules/views/src/Plugin/views/display/Block.php Block
  9. 8.1.x core/modules/block/src/Plugin/migrate/source/Block.php Block
  10. 8.1.x core/modules/views/src/Plugin/views/display/Block.php Block
  11. 8.1.x core/lib/Drupal/Core/Block/Annotation/Block.php Block
  12. 8.1.x core/modules/block/src/Entity/Block.php Block
  13. 8.3.x core/modules/views/src/Plugin/views/display/Block.php Block
  14. 8.3.x core/modules/block/src/Plugin/migrate/source/Block.php Block
  15. 8.3.x core/lib/Drupal/Core/Block/Annotation/Block.php Block
  16. 8.3.x core/modules/block/src/Entity/Block.php Block

Defines a Block annotation object.

Hierarchy

Expanded class hierarchy of Block

Related topics

29 string references to 'Block'
block.info.yml in core/modules/block/block.info.yml
core/modules/block/block.info.yml
block.schema.yml in core/modules/block/config/schema/block.schema.yml
core/modules/block/config/schema/block.schema.yml
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php
Shows a list of blocks that can be added to a theme's layout.
BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php
Builds the main "Blocks" portion of the form.
BlockManager::getGroupedDefinitions in core/lib/Drupal/Core/Block/BlockManager.php
Gets sorted plugin definitions grouped by category.

... See full list

37 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.
AjaxFormBlock in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
Provides an AJAX form block.
BlockContentBlock in core/modules/block_content/src/Plugin/Block/BlockContentBlock.php
Defines a generic custom block type.
BookNavigationBlock in core/modules/book/src/Plugin/Block/BookNavigationBlock.php
Provides a 'Book navigation' block.

... See full list

File

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

Namespace

Drupal\Core\Block\Annotation
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 = '';

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
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::$id public property The plugin ID.
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
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
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
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.