Block.php
Same filename in this branch
Same filename in other branches
- 9 core/modules/views/src/Plugin/views/display/Block.php
- 9 core/modules/block/src/Entity/Block.php
- 9 core/modules/block/src/Plugin/migrate/source/Block.php
- 9 core/lib/Drupal/Core/Block/Annotation/Block.php
- 10 core/modules/views/src/Plugin/views/display/Block.php
- 10 core/modules/block/src/Entity/Block.php
- 10 core/modules/block/src/Plugin/migrate/source/Block.php
- 10 core/lib/Drupal/Core/Block/Attribute/Block.php
- 10 core/lib/Drupal/Core/Block/Annotation/Block.php
- 11.x core/modules/views/src/Plugin/views/display/Block.php
- 11.x core/modules/block/src/Entity/Block.php
- 11.x core/modules/block/src/Plugin/migrate/source/Block.php
- 11.x core/lib/Drupal/Core/Block/Attribute/Block.php
- 11.x core/lib/Drupal/Core/Block/Annotation/Block.php
Namespace
Drupal\Core\Block\AnnotationFile
-
core/
lib/ Drupal/ Core/ Block/ Annotation/ Block.php
View source
<?php
namespace Drupal\Core\Block\Annotation;
use Drupal\Component\Annotation\Plugin;
/**
* Defines a Block annotation object.
*
* @ingroup block_api
*
* @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[]
*
* @deprecated Providing context definitions via the "context" key is
* deprecated in Drupal 8.7.x and will be removed before Drupal 9.0.0. Use
* the "context_definitions" key instead.
*/
public $context = [];
/**
* 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 = [];
}
Classes
Title | Deprecated | Summary |
---|---|---|
Block | Defines a Block annotation object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.