class UnpublishAction
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php \Drupal\Core\Action\Plugin\Action\UnpublishAction
- 10 core/lib/Drupal/Core/Action/Plugin/Action/UnpublishAction.php \Drupal\Core\Action\Plugin\Action\UnpublishAction
- 8.9.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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Action\ActionBase implements \Drupal\Core\Action\ActionInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\Plugin\Action\UnpublishAction extends \Drupal\Core\Action\Plugin\Action\EntityActionBase
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\ActionBase implements \Drupal\Core\Action\ActionInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
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\ActionView 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();
}
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.