You are here

Home » API reference » Drupal 10 » BlockInterface.php

interface BlockInterface in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/block/src/BlockInterface.php \Drupal\block\BlockInterface
  2. 9 core/modules/block/src/BlockInterface.php \Drupal\block\BlockInterface

Provides an interface defining a block entity.

Hierarchy

Expanded class hierarchy of BlockInterface

All classes that implement BlockInterface

7 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

... See full list

File

core/modules/block/src/BlockInterface.php, line 10

Namespace

Drupal\block
View source 
interface BlockInterface extends ConfigEntityInterface {

  /**
   * 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

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 4
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. 21
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 21
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 14
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. 1
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 1
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 1
EntityInterface::delete public function Deletes an entity permanently. 1
EntityInterface::enforceIsNew public function Enforces an entity to be new. 1
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 1
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 1
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 1
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 1
EntityInterface::getEntityType public function Gets the entity type definition. 1
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 1
EntityInterface::getOriginalId public function Gets the original ID. 1
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 1
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 1
EntityInterface::id public function Gets the identifier. 1
EntityInterface::isNew public function Determines whether the entity is new. 1
EntityInterface::label public function Gets the label of the entity. 1
EntityInterface::language public function Gets the language of the entity. 1
EntityInterface::load public static function Loads an entity. 1
EntityInterface::loadMultiple public static function Loads one or more entities. 1
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 1
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 1
EntityInterface::postLoad public static function Acts on loaded entities. 1
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 1
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 1
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 1
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 1
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 1
EntityInterface::save public function Saves an entity permanently. 1
EntityInterface::setOriginalId public function Sets the original ID. 1
EntityInterface::toArray public function Gets an array of all property values. 1
EntityInterface::toLink public function Generates the HTML for a link to this entity. 1
EntityInterface::toUrl public function Gets the URL object for the entity. 1
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 1
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 1
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. 4
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 4
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 4
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 4
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 4