1. 8.5.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  2. 8.0.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  3. 8.1.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  4. 8.2.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  5. 8.3.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  6. 8.4.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm
  7. 8.6.x core/lib/Drupal/Core/Entity/EntityDeleteForm.php EntityDeleteForm

Provides a generic base class for an entity deletion form.


Expanded class hierarchy of EntityDeleteForm

Related topics

14 files declare their use of EntityDeleteForm
ActionDeleteForm.php in core/modules/action/src/Form/ActionDeleteForm.php
BlockContentTypeDeleteForm.php in core/modules/block_content/src/Form/BlockContentTypeDeleteForm.php
BlockDeleteForm.php in core/modules/block/src/Form/BlockDeleteForm.php
CommentTypeDeleteForm.php in core/modules/comment/src/Form/CommentTypeDeleteForm.php
DateFormatDeleteForm.php in core/modules/system/src/Form/DateFormatDeleteForm.php

... See full list


core/lib/Drupal/Core/Entity/EntityDeleteForm.php, line 13


View source
class EntityDeleteForm extends EntityConfirmFormBase {
  use EntityDeleteFormTrait;

   * {@inheritdoc}
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $entity = $this

    // Only do dependency processing for configuration entities. Whilst it is
    // possible for a configuration entity to be dependent on a content entity,
    // these dependencies are soft and content delete permissions are often
    // given to more users. This method should not make assumptions that $entity
    // is a configuration entity in case we decide to remove the following
    // condition.
    if (!$entity instanceof ConfigEntityInterface) {
      return $form;
      ->addDependencyListsToForm($form, $entity
      ->getConfigDependencyKey(), $this
      ->getConfigNamesToDelete($entity), $this
      ->getConfigManager(), $this->entityManager);
    return $form;

   * Gets the configuration manager.
   * @return \Drupal\Core\Config\ConfigManager
   *   The configuration manager.
  protected function getConfigManager() {
    return \Drupal::service('config.manager');

   * Returns config names to delete for the deletion confirmation form.
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface $entity
   *   The entity being deleted.
   * @return string[]
   *   A list of configuration names that will be deleted by this form.
  protected function getConfigNamesToDelete(ConfigEntityInterface $entity) {
    return [



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm protected function Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t abstract protected function Translates a string to the current language or to a given language. Overrides StringTranslationTrait::t
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties. Overrides KernelTestBase::__sleep
DependencySerializationTrait::__wakeup public function
EntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
EntityConfirmFormBase::delete public function The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
EntityConfirmFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
EntityConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
EntityConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription
EntityConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
EntityDeleteForm::buildForm public function Form constructor. Overrides EntityConfirmFormBase::buildForm
EntityDeleteForm::getConfigManager protected function Gets the configuration manager.
EntityDeleteForm::getConfigNamesToDelete protected function Returns config names to delete for the deletion confirmation form.
EntityDeleteFormTrait::getCancelUrl public function Returns the route to go to if the user cancels the action.
EntityDeleteFormTrait::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ContentEntityConfirmFormBase::getConfirmText
EntityDeleteFormTrait::getDeletionMessage protected function Gets the message to display to the user after deleting the entity.
EntityDeleteFormTrait::getEntity abstract public function Gets the entity of this form. Overrides EntityForm::getEntity
EntityDeleteFormTrait::getQuestion public function Returns the question to ask the user.
EntityDeleteFormTrait::getRedirectUrl protected function Returns the URL where the user should be redirected after deletion.
EntityDeleteFormTrait::logDeletionMessage protected function Logs a message about the deleted entity.
EntityDeleteFormTrait::logger abstract protected function Gets the logger for a specific channel. Overrides FormBase::logger
EntityDeleteFormTrait::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
EntityForm::$entity protected property The entity being used by this form.
EntityForm::$entityManager Deprecated protected property The entity manager.
EntityForm::$entityTypeManager protected property The entity type manager.
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties
EntityForm::form public function Gets the actual form array to be built.
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build.
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first.
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory.
FormBase::$requestStack protected property The request stack.
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form.
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm
LinkGeneratorTrait::$linkGenerator protected property The link generator.
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.