class UnpublishAction

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php \Drupal\Core\Action\Plugin\Action\UnpublishAction
  2. 10 core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php \Drupal\Core\Action\Plugin\Action\UnpublishAction
  3. 11.x core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php \Drupal\Core\Action\Plugin\Action\UnpublishAction

Unpublishes an entity.

Plugin annotation


@Action(
  id = "entity:unpublish_action",
  action_label = @Translation("Unpublish"),
  deriver = "Drupal\Core\Action\Plugin\Action\Derivative\EntityPublishedActionDeriver",
)

Hierarchy

Expanded class hierarchy of UnpublishAction

2 files declare their use of UnpublishAction
content_moderation.module in core/modules/content_moderation/content_moderation.module
Contains content_moderation.module.
ModerationOptOutUnpublish.php in core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php

File

core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php, line 16

Namespace

Drupal\Core\Action\Plugin\Action
View on git.drupalcode.org
View source 
class UnpublishAction extends EntityActionBase {
  
  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $entity->setUnpublished()
      ->save();
  }
  
  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $key = $object->getEntityType()
      ->getKey('published');
    /** @var \Drupal\Core\Entity\EntityInterface $object */
    $result = $object->access('update', $account, TRUE)
      ->andIf($object->{$key}
      ->access('edit', $account, TRUE));
    return $return_as_object ? $result : $result->isAllowed();
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
EntityActionBase::$entityTypeManager protected property The entity type manager.
EntityActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EntityActionBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 4
EntityActionBase::__construct public function Constructs an EntityActionBase object. Overrides PluginBase::__construct 4
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UnpublishAction::access public function Checks object access. Overrides ActionInterface::access 1
UnpublishAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.