function PublishAction::access

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

Checks object access.

Parameters

mixed $object: The object to execute the action on.

\Drupal\Core\Session\AccountInterface $account: (optional) The user for which to check access, or NULL to check access for the current user. Defaults to NULL.

bool $return_as_object: (optional) Defaults to FALSE.

Return value

bool|\Drupal\Core\Access\AccessResultInterface The access result. Returns a boolean if $return_as_object is FALSE (this is the default) and otherwise an AccessResultInterface object. When a boolean is returned, the result of AccessInterface::isAllowed() is returned, i.e. TRUE means access is explicitly allowed, FALSE means access is either explicitly forbidden or "no opinion".

Overrides ActionInterface::access

1 call to PublishAction::access()
ModerationOptOutPublish::access in core/modules/content_moderation/src/Plugin/Action/ModerationOptOutPublish.php
Checks object access.
1 method overrides PublishAction::access()
ModerationOptOutPublish::access in core/modules/content_moderation/src/Plugin/Action/ModerationOptOutPublish.php
Checks object access.

File

core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php, line 28

Class

PublishAction
Publishes an entity.

Namespace

Drupal\Core\Action\Plugin\Action

Code

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.