class PublishAction
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php \Drupal\Core\Action\Plugin\Action\PublishAction
- 10 core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php \Drupal\Core\Action\Plugin\Action\PublishAction
- 11.x core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php \Drupal\Core\Action\Plugin\Action\PublishAction
Publishes an entity.
Plugin annotation
@Action(
id = "entity:publish_action",
action_label = @Translation("Publish"),
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 extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Action\Plugin\Action\PublishAction extends \Drupal\Core\Action\Plugin\Action\EntityActionBase
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of PublishAction
2 files declare their use of PublishAction
- content_moderation.module in core/
modules/ content_moderation/ content_moderation.module - Contains content_moderation.module.
- ModerationOptOutPublish.php in core/
modules/ content_moderation/ src/ Plugin/ Action/ ModerationOptOutPublish.php
File
-
core/
lib/ Drupal/ Core/ Action/ Plugin/ Action/ PublishAction.php, line 16
Namespace
Drupal\Core\Action\Plugin\ActionView source
class PublishAction extends EntityActionBase {
/**
* {@inheritdoc}
*/
public function execute($entity = NULL) {
$entity->setPublished()
->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 an EntityActionBase object. | 4 | |
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 | |
PublishAction::access | public | function | Checks object access. | Overrides ActionInterface::access | 1 |
PublishAction::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.