class BlockUser

Same name in other branches
  1. 9 core/modules/user/src/Plugin/Action/BlockUser.php \Drupal\user\Plugin\Action\BlockUser
  2. 10 core/modules/user/src/Plugin/Action/BlockUser.php \Drupal\user\Plugin\Action\BlockUser
  3. 11.x core/modules/user/src/Plugin/Action/BlockUser.php \Drupal\user\Plugin\Action\BlockUser

Blocks a user.

Plugin annotation


@Action(
  id = "user_block_user_action",
  label = @Translation("Block the selected users"),
  type = "user"
)

Hierarchy

Expanded class hierarchy of BlockUser

File

core/modules/user/src/Plugin/Action/BlockUser.php, line 17

Namespace

Drupal\user\Plugin\Action
View source
class BlockUser extends ActionBase {
    
    /**
     * {@inheritdoc}
     */
    public function execute($account = NULL) {
        // Skip blocking user if they are already blocked.
        if ($account !== FALSE && $account->isActive()) {
            // For efficiency manually save the original account before applying any
            // changes.
            $account->original = clone $account;
            $account->block();
            $account->save();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
        
        /** @var \Drupal\user\UserInterface $object */
        $access = $object->status
            ->access('edit', $account, TRUE)
            ->andIf($object->access('update', $account, TRUE));
        return $return_as_object ? $access : $access->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
BlockUser::access public function Checks object access. Overrides ActionInterface::access
BlockUser::execute public function Executes the plugin. Overrides ExecutableInterface::execute
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.