The documentation for EntityInterface::save() says:
* @return int
* Either SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
However:
1. EntityBase::save() just hands over to the storage handler and returns what it returns:
public function save() {
$storage = $this->entityTypeManager()->getStorage($this->entityTypeId);
return $storage->save($this);
}
2. EntityStorageBase::save() calls doSave() on itself, and returns what that returns:
public function save(EntityInterface $entity) {
// Track if this entity is new.
$is_new = $entity->isNew();
// Execute presave logic and invoke the related hooks.
$id = $this->doPreSave($entity);
// Perform the save and reset the static cache for the changed entity.
$return = $this->doSave($id, $entity);
// Execute post save logic and invoke the related hooks.
$this->doPostSave($entity, !$is_new);
return $return;
and doSave() documents that it can return FALSE:
* @return bool|int
* If the record insert or update failed, returns FALSE. If it succeeded,
* returns SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
and indeed we can see this in ContentEntityStorageBase::doSave():
$return = $entity->isDefaultRevision() ? SAVED_UPDATED : FALSE;
Therefore, it's possible for EntityInterface::save() to return FALSE.
Fix the docs.
(And needs backport to D8, but I can't find a tag for that.)
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
entity save always throws an exception when there is an error in saving. It however can return FALSE in case of a non-default revision, for which there is an existing issue, closing as duplicate of that: 🐛 Consider not returning FALSE when saving a non-default entity revision Needs work