You are here

public function ContentEntityTypeInterface::getRevisionMetadataKeys in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php \Drupal\Core\Entity\ContentEntityTypeInterface::getRevisionMetadataKeys()
  2. 10 core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php \Drupal\Core\Entity\ContentEntityTypeInterface::getRevisionMetadataKeys()

Gets an array of entity revision metadata keys.

Parameters

bool $include_backwards_compatibility_field_names: (optional and deprecated) Whether to provide the revision keys on a best-effort basis by looking at the base fields defined by the entity type. Note that this parameter will be removed in Drupal 9.0.0. Defaults to TRUE.

Return value

array An array describing how the Field API can extract revision metadata information of this entity type:

  • revision_log_message: The name of the property that contains description of the changes that were made in the current revision.
  • revision_user: The name of the property that contains the user ID of the author of the current revision.
  • revision_created: The name of the property that contains the timestamp of the current revision.
1 method overrides ContentEntityTypeInterface::getRevisionMetadataKeys()
ContentEntityType::getRevisionMetadataKeys in core/lib/Drupal/Core/Entity/ContentEntityType.php
Gets an array of entity revision metadata keys.

File

core/lib/Drupal/Core/Entity/ContentEntityTypeInterface.php, line 29

Class

ContentEntityTypeInterface
Provides an interface for a content entity type and its metadata.

Namespace

Drupal\Core\Entity

Code

public function getRevisionMetadataKeys($include_backwards_compatibility_field_names = TRUE);