class UnpublishAction

Same name in other branches
  1. 9 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

4 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
UnpublishComment.php in core/modules/comment/src/Plugin/Action/UnpublishComment.php
UnpublishNode.php in core/modules/node/src/Plugin/Action/UnpublishNode.php

File

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

Namespace

Drupal\Core\Action\Plugin\Action
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 Sort descending Modifiers Object type Summary Overriden Title Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
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 a EntityActionBase object. 8
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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.