class Block in Drupal 10

Defines a Block annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\Core\Block\Annotation\Block

Related topics

Annotations

Annotations for class discovery and metadata description.

Block API

Information about the classes and interfaces that make up the Block API.

43 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.

BlockManagerTest::setUp in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php

... See full list

50 classes are annotated with Block

ActiveTopicsBlock in core/modules/forum/src/Plugin/Block/ActiveTopicsBlock.php

Provides an 'Active forum topics' block.

AjaxFormBlock in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php

Provides an AJAX form block.

AttachedRenderingBlock in core/modules/system/tests/modules/render_attached_test/src/Plugin/Block/AttachedRenderingBlock.php

A block we can use to test caching of #attached headers.

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

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

Name	Modifiers	Type	Description	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