Defines the custom block entity class.
@ContentEntityType( id = "block_content", label = @Translation("Custom block"), bundle_label = @Translation("Custom block type"), handlers = { "storage" = "Drupal\Core\Entity\Sql\SqlContentEntityStorage", "access" = "Drupal\block_content\BlockContentAccessControlHandler", "list_builder" = "Drupal\block_content\BlockContentListBuilder", "view_builder" = "Drupal\block_content\BlockContentViewBuilder", "views_data" = "Drupal\block_content\BlockContentViewsData", "form" = { "add" = "Drupal\block_content\BlockContentForm", "edit" = "Drupal\block_content\BlockContentForm", "delete" = "Drupal\block_content\Form\BlockContentDeleteForm", "default" = "Drupal\block_content\BlockContentForm" }, "translation" = "Drupal\block_content\BlockContentTranslationHandler" }, admin_permission = "administer blocks", base_table = "block_content", revision_table = "block_content_revision", data_table = "block_content_field_data", links = { "canonical" = "/block/{block_content}", "delete-form" = "/block/{block_content}/delete", "edit-form" = "/block/{block_content}", "collection" = "/admin/structure/block/block-content", }, translatable = TRUE, entity_keys = { "id" = "id", "revision" = "revision_id", "bundle" = "type", "label" = "info", "langcode" = "langcode", "uuid" = "uuid" }, bundle_entity_type = "block_content_type", field_ui_base_route = "entity.block_content_type.edit_form", render_cache = FALSE, )
Note that render caching of block_content entities is disabled because they are always rendered as blocks, and blocks already have their own render caching. See https://www.drupal.org/node/2284917#comment-9132521 for more information.
Hierarchy
- class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \IteratorAggregate, ContentEntityInterface
- class \Drupal\block_content\Entity\BlockContent implements BlockContentInterface uses EntityChangedTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \IteratorAggregate, ContentEntityInterface
File
- core/modules/block_content/src/Entity/BlockContent.php, line 63
Namespace
Drupal\block_content\Entity
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| BlockContent::$theme | protected | property | The theme the block is being created in. |
| BlockContent::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions |
| BlockContent::createDuplicate | public | function | Creates a duplicate of the entity. Overrides ContentEntityBase::createDuplicate |
| BlockContent::delete | public | function | Deletes an entity permanently. Overrides Entity::delete |
| BlockContent::getInstances | public | function | Gets the configured instances of this custom block. Overrides BlockContentInterface::getInstances |
| BlockContent::getRevisionCreationTime | public | function | Gets the entity revision creation timestamp. Overrides RevisionLogInterface::getRevisionCreationTime |
| BlockContent::getRevisionLog | public | function | Returns the block revision log message. Overrides BlockContentInterface::getRevisionLog |
| BlockContent::getRevisionLogMessage | public | function | Returns the entity revision log message. Overrides RevisionLogInterface::getRevisionLogMessage |
| BlockContent::getRevisionUser | public | function | Gets the entity revision author. Overrides RevisionLogInterface::getRevisionUser |
| BlockContent::getRevisionUserId | public | function | Gets the entity revision author ID. Overrides RevisionLogInterface::getRevisionUserId |
| BlockContent::getTheme | public | function | Gets the theme value. Overrides BlockContentInterface::getTheme |
| BlockContent::invalidateBlockPluginCache | protected static | function | Invalidates the block plugin cache after changes and deletions. |
| BlockContent::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. Overrides Entity::postDelete |
| BlockContent::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::postSave |
| BlockContent::preSaveRevision | public | function | Acts on a revision before it gets saved. Overrides ContentEntityBase::preSaveRevision |
| BlockContent::setInfo | public | function | Sets the block description. Overrides BlockContentInterface::setInfo |
| BlockContent::setRevisionCreationTime | public | function | Sets the entity revision creation timestamp. Overrides RevisionLogInterface::setRevisionCreationTime |
| BlockContent::setRevisionLog | public | function | Sets the block revision log message. Overrides BlockContentInterface::setRevisionLog |
| BlockContent::setRevisionLogMessage | public | function | Sets the entity revision log message. Overrides RevisionLogInterface::setRevisionLogMessage |
| BlockContent::setRevisionUser | public | function | Sets the entity revision author. Overrides RevisionLogInterface::setRevisionUser |
| BlockContent::setRevisionUserId | public | function | Sets the entity revision author by ID. Overrides RevisionLogInterface::setRevisionUserId |
| BlockContent::setTheme | public | function | Sets the theme value. Overrides BlockContentInterface::setTheme |
| ContentEntityBase::$activeLangcode | protected | property | Language code identifying the entity active language. |
| ContentEntityBase::$defaultLangcode | protected | property | Local cache for the default language code. |
| ContentEntityBase::$defaultLangcodeKey | protected | property | The default langcode entity key. |
| ContentEntityBase::$entityKeys | protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. |
| ContentEntityBase::$fieldDefinitions | protected | property | Local cache for field definitions. |
| ContentEntityBase::$fields | protected | property | The array of fields, each being an instance of FieldItemListInterface. |
| ContentEntityBase::$isDefaultRevision | protected | property | Indicates whether this is the default revision. |
| ContentEntityBase::$langcodeKey | protected | property | The language entity key. |
| ContentEntityBase::$languages | protected | property | Local cache for the available language objects. |
| ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. |
| ContentEntityBase::$translatableEntityKeys | protected | property | Holds translatable entity keys such as the label. |
| ContentEntityBase::$translationInitialize | protected | property | A flag indicating whether a translation object is being initialized. |
| ContentEntityBase::$translations | protected | property | An array of entity translation metadata. |
| ContentEntityBase::$validated | protected | property | Whether entity validation was performed. |
| ContentEntityBase::$validationRequired | protected | property | Whether entity validation is required before saving the entity. |
| ContentEntityBase::$values | protected | property | The plain data values of the contained fields. |
| ContentEntityBase::access | public | function | Checks data value access. Overrides Entity::access |
| ContentEntityBase::addTranslation | public | function | Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation |
| ContentEntityBase::bundle | public | function | Gets the bundle of the entity. Overrides Entity::bundle |
| ContentEntityBase::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions |
| ContentEntityBase::clearTranslationCache | protected | function | Clear entity translation object cache to remove stale references. |
| ContentEntityBase::get | public | function | Gets a field item list. Overrides FieldableEntityInterface::get |
| ContentEntityBase::getEntityKey | protected | function | Gets the value of the given entity key, if defined. |
| ContentEntityBase::getFieldDefinition | public | function | Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition |
| ContentEntityBase::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions |
| ContentEntityBase::getFields | public | function | Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields |
| ContentEntityBase::getIterator | public | function | |
| ContentEntityBase::getLanguages | protected | function | |
| ContentEntityBase::getRevisionId | public | function | Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId |
| ContentEntityBase::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields |
| ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. |
| ContentEntityBase::getTranslation | public | function | Gets a translation of the data. Overrides TranslatableInterface::getTranslation |
| ContentEntityBase::getTranslationLanguages | public | function | Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages |
| ContentEntityBase::getUntranslated | public | function | Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated |
| ContentEntityBase::hasField | public | function | Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField |
| ContentEntityBase::hasTranslation | public | function | Returns TRUE there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation |
| ContentEntityBase::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. Overrides ContentEntityInterface::hasTranslationChanges |
| ContentEntityBase::id | public | function | Gets the identifier. Overrides Entity::id |
| ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. |
| ContentEntityBase::isDefaultRevision | public | function | Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision |
| ContentEntityBase::isDefaultTranslation | public | function | Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation |
| ContentEntityBase::isNewRevision | public | function | Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision |
| ContentEntityBase::isNewTranslation | public | function | Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation |
| ContentEntityBase::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. Overrides ContentEntityInterface::isRevisionTranslationAffected |
| ContentEntityBase::isTranslatable | public | function | Returns the translation support status. Overrides TranslatableInterface::isTranslatable |
| ContentEntityBase::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired |
| ContentEntityBase::label | public | function | Gets the label of the entity. Overrides Entity::label |
| ContentEntityBase::language | public | function | Gets the language of the entity. Overrides Entity::language |
| ContentEntityBase::onChange | public | function | Reacts to changes to a field. Overrides FieldableEntityInterface::onChange |
| ContentEntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. Overrides Entity::postCreate |
| ContentEntityBase::preSave | public | function | Acts on an entity before the presave hook is invoked. Overrides Entity::preSave |
| ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. Overrides Entity::referencedEntities |
| ContentEntityBase::removeTranslation | public | function | Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation |
| ContentEntityBase::set | public | function | Sets a field value. Overrides FieldableEntityInterface::set |
| ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. |
| ContentEntityBase::setNewRevision | public | function | Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision |
| ContentEntityBase::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. Overrides ContentEntityInterface::setRevisionTranslationAffected |
| ContentEntityBase::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired |
| ContentEntityBase::toArray | public | function | Gets an array of all property values. Overrides Entity::toArray |
| ContentEntityBase::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | |
| ContentEntityBase::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | |
| ContentEntityBase::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. | |
| ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. |
| ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. |
| ContentEntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). Overrides Entity::uuid |
| ContentEntityBase::validate | public | function | Validates the currently set values. Overrides FieldableEntityInterface::validate |
| ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. |
| ContentEntityBase::__construct | public | function | Constructs an Entity object. Overrides Entity::__construct |
| ContentEntityBase::__get | public | function | Implements the magic method for getting object properties. |
| ContentEntityBase::__isset | public | function | Implements the magic method for isset(). |
| ContentEntityBase::__set | public | function | Implements the magic method for setting object properties. |
| ContentEntityBase::__sleep | public | function | Overrides Entity::__sleep |
| ContentEntityBase::__unset | public | function | Implements the magic method for unset(). |
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep |
| DependencySerializationTrait::__wakeup | public | function | |
| Entity::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. |
| Entity::$entityTypeId | protected | property | The entity type. |
| Entity::$typedData | protected | property | A typed data object wrapping this entity. |
| Entity::create | public static | function | Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create |
| Entity::enforceIsNew | public | function | Enforces an entity to be new. Overrides EntityInterface::enforceIsNew |
| Entity::entityManager Deprecated | protected | function | Gets the entity manager. |
| Entity::entityTypeManager | protected | function | Gets the entity type manager. |
| Entity::getCacheContexts | public | function | The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts |
| Entity::getCacheMaxAge | public | function | The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge |
| Entity::getCacheTags | public | function | The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags |
| Entity::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate |
| Entity::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey |
| Entity::getConfigDependencyName | public | function | Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName |
| Entity::getConfigTarget | public | function | Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget |
| Entity::getEntityType | public | function | Gets the entity type definition. Overrides EntityInterface::getEntityType |
| Entity::getEntityTypeId | public | function | Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId |
| Entity::getOriginalId | public | function | Gets the original ID. Overrides EntityInterface::getOriginalId |
| Entity::getTypedData | public | function | Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData |
| Entity::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate |
| Entity::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. |
| Entity::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. |
| Entity::isNew | public | function | Determines whether the entity is new. Overrides EntityInterface::isNew |
| Entity::languageManager | protected | function | Gets the language manager. |
| Entity::link | public | function | Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link |
| Entity::linkTemplates | protected | function | Gets an array link templates. |
| Entity::load | public static | function | Loads an entity. Overrides EntityInterface::load |
| Entity::loadMultiple | public static | function | Loads one or more entities. Overrides EntityInterface::loadMultiple |
| Entity::postLoad | public static | function | Acts on loaded entities. Overrides EntityInterface::postLoad |
| Entity::preCreate | public static | function | Changes the values of an entity before it is created. Overrides EntityInterface::preCreate |
| Entity::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete |
| Entity::save | public | function | Saves an entity permanently. Overrides EntityInterface::save |
| Entity::setOriginalId | public | function | Sets the original ID. Overrides EntityInterface::setOriginalId |
| Entity::toLink | public | function | Generates the HTML for a link to this entity. Overrides EntityInterface::toLink |
| Entity::toUrl | public | function | Gets the URL object for the entity. Overrides EntityInterface::toUrl |
| Entity::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships |
| Entity::url | public | function | Gets the public URL for this entity. Overrides EntityInterface::url |
| Entity::urlInfo | public | function | Gets the URL object for the entity. Overrides EntityInterface::urlInfo |
| Entity::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. |
| Entity::uuidGenerator | protected | function | Gets the UUID generator. |
| EntityChangedTrait::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. Overrides EntityChangedInterface::getChangedTime |
| EntityChangedTrait::getChangedTimeAcrossTranslations | public | function | Returns the timestamp of the last entity change across all translations. Overrides EntityChangedInterface::getChangedTimeAcrossTranslations |
| EntityChangedTrait::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. Overrides EntityChangedInterface::setChangedTime |
| RefinableCacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. |
| RefinableCacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. |
| RefinableCacheableDependencyTrait::$cacheTags | protected | property | Cache tags. |
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency |
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts |
| RefinableCacheableDependencyTrait::addCacheTags | public | function | Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags |
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge |
Please login to continue.