Skip navigation
Help

entity_create_stub_entity

7 common.inc entity_create_stub_entity($entity_type, $ids)

Helper function to assemble an object structure with initial ids.

This function can be seen as reciprocal to entity_extract_ids().

Parameters

$entity_type: The entity type; e.g. 'node' or 'user'.

$ids: A numerically indexed array, as returned by entity_extract_ids(), containing these elements: 0: primary id of the entity 1: revision id of the entity, or NULL if $entity_type is not versioned 2: bundle name of the entity, or NULL if $entity_type has no bundles

Return value

An entity structure, initialized with the ids provided.

5 calls to entity_create_stub_entity()

File

drupal/includes/common.inc, line 7410
Common functions that many Drupal modules will need to reference.

Code

function entity_create_stub_entity($entity_type, $ids) {
  $entity = new stdClass();
  $info = entity_get_info($entity_type);
  $entity->{$info['entity keys']['id']} = $ids[0];
  if (!empty($info['entity keys']['revision']) && isset($ids[1])) {
    $entity->{$info['entity keys']['revision']} = $ids[1];
  }
  if (!empty($info['entity keys']['bundle']) && isset($ids[2])) {
    $entity->{$info['entity keys']['bundle']} = $ids[2];
  }
  return $entity;
}