public function ConfigEntityInterface::onDependencyRemoval in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php \Drupal\Core\Config\Entity\ConfigEntityInterface::onDependencyRemoval()
2. 9 core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php \Drupal\Core\Config\Entity\ConfigEntityInterface::onDependencyRemoval()

Informs the entity that entities it depends on will be deleted.

This method allows configuration entities to remove dependencies instead of being deleted themselves. Configuration entities can use this method to avoid being unnecessarily deleted during an extension uninstallation. For example, entity displays remove references to widgets and formatters if the plugin that supplies them depends on a module that is being uninstalled.

If this method returns TRUE then the entity needs to be re-saved by the caller for the changes to take effect. Implementations should not save the entity.

Parameters

array $dependencies: An array of dependencies that will be deleted keyed by dependency type. Dependency types are, for example, entity, module and theme.

Return value

bool TRUE if the entity has been changed as a result, FALSE if not.

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

\Drupal\Core\Config\ConfigEntityBase::preDelete()

\Drupal\Core\Config\ConfigManager::uninstall()

\Drupal\Core\Entity\EntityDisplayBase::onDependencyRemoval()

2 methods override ConfigEntityInterface::onDependencyRemoval()

ConfigEntityBase::onDependencyRemoval in core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php

Informs the entity that entities it depends on will be deleted.

ViewUI::onDependencyRemoval in core/modules/views_ui/src/ViewUI.php

Informs the entity that entities it depends on will be deleted.

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php, line 135

Class

ConfigEntityInterface

Defines a common interface for configuration entities.

Namespace

Drupal\Core\Config\Entity

Code

public function onDependencyRemoval(array $dependencies);