interface BlockInterface
Same name in other branches
- 9 core/modules/block/src/BlockInterface.php \Drupal\block\BlockInterface
- 10 core/modules/block/src/BlockInterface.php \Drupal\block\BlockInterface
- 11.x core/modules/block/src/BlockInterface.php \Drupal\block\BlockInterface
Provides an interface defining a block entity.
Hierarchy
- interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface \Drupal\Core\Cache\CacheableDependencyInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\block\BlockInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of BlockInterface
All classes that implement BlockInterface
8 files declare their use of BlockInterface
- Block.php in core/
modules/ block/ src/ Entity/ Block.php - BlockController.php in core/
modules/ block/ src/ Controller/ BlockController.php - BlockEntitySettingTrayForm.php in core/
modules/ settings_tray/ src/ Block/ BlockEntitySettingTrayForm.php - BlockHasOverridesAccessCheck.php in core/
modules/ settings_tray/ src/ Access/ BlockHasOverridesAccessCheck.php - BlockPluginHasSettingsTrayFormAccessCheck.php in core/
modules/ settings_tray/ src/ Access/ BlockPluginHasSettingsTrayFormAccessCheck.php
File
-
core/
modules/ block/ src/ BlockInterface.php, line 11
Namespace
Drupal\blockView source
interface BlockInterface extends ConfigEntityInterface {
/**
* Indicates the block label (title) should be displayed to end users.
*
* @deprecated in drupal:8.3.0 and is removed from drupal:9.0.0.
* Use \Drupal\Core\Block\BlockPluginInterface::BLOCK_LABEL_VISIBLE.
*
* @see https://www.drupal.org/node/2829775
*/
const BLOCK_LABEL_VISIBLE = BlockPluginInterface::BLOCK_LABEL_VISIBLE;
/**
* Denotes that a block is not enabled in any region and should not be shown.
*
* @deprecated in drupal:8.?.? and is removed from drupal:9.0.0.
*/
const BLOCK_REGION_NONE = -1;
/**
* Returns the plugin instance.
*
* @return \Drupal\Core\Block\BlockPluginInterface
* The plugin instance for this block.
*/
public function getPlugin();
/**
* Returns the plugin ID.
*
* @return string
* The plugin ID for this block.
*/
public function getPluginId();
/**
* Returns the region this block is placed in.
*
* @return string
* The region this block is placed in.
*/
public function getRegion();
/**
* Returns the theme ID.
*
* @return string
* The theme ID for this block instance.
*/
public function getTheme();
/**
* Returns an array of visibility condition configurations.
*
* @return array
* An array of visibility condition configuration keyed by the condition ID.
*/
public function getVisibility();
/**
* Gets conditions for this block.
*
* @return \Drupal\Core\Condition\ConditionInterface[]|\Drupal\Core\Condition\ConditionPluginCollection
* An array or collection of configured condition plugins.
*/
public function getVisibilityConditions();
/**
* Gets a visibility condition plugin instance.
*
* @param string $instance_id
* The condition plugin instance ID.
*
* @return \Drupal\Core\Condition\ConditionInterface
* A condition plugin.
*/
public function getVisibilityCondition($instance_id);
/**
* Sets the visibility condition configuration.
*
* @param string $instance_id
* The condition instance ID.
* @param array $configuration
* The condition configuration.
*
* @return $this
*/
public function setVisibilityConfig($instance_id, array $configuration);
/**
* Returns the weight of this block (used for sorting).
*
* @return int
* The block weight.
*/
public function getWeight();
/**
* Sets the region this block is placed in.
*
* @param string $region
* The region to place this block in.
*
* @return $this
*/
public function setRegion($region);
/**
* Sets the block weight.
*
* @param int $weight
* The desired weight.
*
* @return $this
*/
public function setWeight($weight);
/**
* Creates a duplicate of the block entity.
*
* @param string $new_id
* (optional) The new ID on the duplicate block.
* @param string $new_theme
* (optional) The theme on the duplicate block.
*
* @return static
* A clone of $this with all identifiers unset, so saving it inserts a new
* entity into the storage system.
*/
public function createDuplicateBlock($new_id = NULL, $new_theme = NULL);
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 | |
BlockInterface::BLOCK_LABEL_VISIBLE | Deprecated | constant | Indicates the block label (title) should be displayed to end users. | ||
BlockInterface::BLOCK_REGION_NONE | Deprecated | constant | Denotes that a block is not enabled in any region and should not be shown. | ||
BlockInterface::createDuplicateBlock | public | function | Creates a duplicate of the block entity. | 1 | |
BlockInterface::getPlugin | public | function | Returns the plugin instance. | 1 | |
BlockInterface::getPluginId | public | function | Returns the plugin ID. | 1 | |
BlockInterface::getRegion | public | function | Returns the region this block is placed in. | 1 | |
BlockInterface::getTheme | public | function | Returns the theme ID. | 1 | |
BlockInterface::getVisibility | public | function | Returns an array of visibility condition configurations. | 1 | |
BlockInterface::getVisibilityCondition | public | function | Gets a visibility condition plugin instance. | 1 | |
BlockInterface::getVisibilityConditions | public | function | Gets conditions for this block. | 1 | |
BlockInterface::getWeight | public | function | Returns the weight of this block (used for sorting). | 1 | |
BlockInterface::setRegion | public | function | Sets the region this block is placed in. | 1 | |
BlockInterface::setVisibilityConfig | public | function | Sets the visibility condition configuration. | 1 | |
BlockInterface::setWeight | public | function | Sets the block weight. | 1 | |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 | |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 | |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 | |
ConfigEntityInterface::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | 2 | |
ConfigEntityInterface::disable | public | function | Disables the configuration entity. | 2 | |
ConfigEntityInterface::enable | public | function | Enables the configuration entity. | 2 | |
ConfigEntityInterface::get | public | function | Returns the value of a property. | 2 | |
ConfigEntityInterface::getDependencies | public | function | Gets the configuration dependencies. | 2 | |
ConfigEntityInterface::hasTrustedData | public | function | Gets whether on not the data is trusted. | 2 | |
ConfigEntityInterface::isInstallable | public | function | Checks whether this entity is installable. | 2 | |
ConfigEntityInterface::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | 2 | |
ConfigEntityInterface::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | 2 | |
ConfigEntityInterface::set | public | function | Sets the value of a property. | 2 | |
ConfigEntityInterface::setStatus | public | function | Sets the status of the configuration entity. | 2 | |
ConfigEntityInterface::status | public | function | Returns whether the configuration entity is enabled. | 2 | |
ConfigEntityInterface::trustData | public | function | Sets that the data should be trusted. | 2 | |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 | |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 | |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 | |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 | |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 | |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 | |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 | |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 | |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 | |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 | |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 | |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 | |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 | |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 | |
EntityInterface::id | public | function | Gets the identifier. | 2 | |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 | |
EntityInterface::label | public | function | Gets the label of the entity. | 2 | |
EntityInterface::language | public | function | Gets the language of the entity. | 2 | |
EntityInterface::link | Deprecated | public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 | |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 | |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 | |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 | |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 | |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 | |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 | |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 | |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 | |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 | |
EntityInterface::save | public | function | Saves an entity permanently. | 2 | |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 | |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 | |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 | |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 | |
EntityInterface::url | Deprecated | public | function | Gets the public URL for this entity. | 2 |
EntityInterface::urlInfo | Deprecated | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 | |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 | |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 | |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 | |
SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 | |
SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 | |
ThirdPartySettingsInterface::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | 5 | |
ThirdPartySettingsInterface::getThirdPartySetting | public | function | Gets the value of a third-party setting. | 5 | |
ThirdPartySettingsInterface::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | 5 | |
ThirdPartySettingsInterface::setThirdPartySetting | public | function | Sets the value of a third-party setting. | 5 | |
ThirdPartySettingsInterface::unsetThirdPartySetting | public | function | Unsets a third-party setting. | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.