I have a custom revisionable entity with a few dozen fields. I'm importing data about the entity on a periodic basis. If the entity has changed, I'd like to save it and create a new revision.

$dogs = \Drupal::entityTypeManager()
  ->loadByProperties(['my_entity_id' => $my_entity_id]);

$dog = reset($dogs);

$dog->set('name', $record['TheName']);
$dog->set('birth_date', $record['Dog Birth Date']);
// Lots more ->set happening here.
$dog->set('notes', $record['Notes']);
if ($dog->someMagicComparisonFunction()) {

I searched for the someMagicComparisonFunction but didn't find it. Does it exist?


This may do the trick in a hook_entity_presave(), or get you close:

$old_dog = clone $dog;

// Use == to allow for out of order keys.
$same = $dog->toArray() == $old_dog->toArray();

This is kinda of cheating, and you may want to filter the arrays for just the fields and not the properties. It also isn't multilingual-safe.

To do it properly, start reading ContentEntityBase::hasTranslationChanges() and FieldItemList::equals(). The code above makes a lot of assumptions about fields and storage, which ContentEntityBase() does properly.

  • 1
    The shown code works also outside of hook_entity_presave().
    – apaderno
    May 21 '19 at 7:02
  • Thanks! I think the comparison should be != if the variable is $changed. This comparison is testing more for a $same - right?
    – greggles
    May 21 '19 at 17:03
  • @greggles Yeah, updated the var name in the code.
    – mpdonadio
    May 21 '19 at 17:55

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.