class UnpublishAction in Drupal 8

Unpublishes an entity.

Plugin annotation

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

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements DependentPluginInterface, ContainerFactoryPluginInterface
        • class \Drupal\Core\Action\Plugin\Action\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

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

Name	Modifiers	Type	Description	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		1
DependencySerializationTrait::__wakeup	public	function		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 a EntityActionBase object. Overrides PluginBase::__construct	8
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	1
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