class UnblockUser

Same name and namespace in other branches

9 core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser
8.9.x core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser
10 core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser

Unblocks a user.

Attributes

#[Action(id: 'user_unblock_user_action', label: new TranslatableMarkup('Unblock the selected users'), type: 'user')]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \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 implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Action\ActionInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\user\Plugin\Action\UnblockUser implements \Drupal\Core\Action\ActionBase

Expanded class hierarchy of UnblockUser

File

core/modules/user/src/Plugin/Action/UnblockUser.php, line 13

Namespace

Drupal\user\Plugin\Action

View on git.drupalcode.org

View source

class UnblockUser extends ActionBase {
  
  /**
   * {@inheritdoc}
   */
  public function execute($account = NULL) {
    // Skip unblocking user if they are already unblocked.
    if ($account !== FALSE && $account->isBlocked()) {
      $account->activate();
      $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	Deprecated	Modifiers	Object type	Summary	Overriden Title	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			3
DependencySerializationTrait::__wakeup		public	function			3
MessengerTrait::$messenger		protected	property	The messenger.		25
MessengerTrait::messenger		public	function	Gets the messenger.		25
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	2
PluginBase::getPluginId		public	function	Gets the plugin ID of the plugin instance.	Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	Deprecated	public	function	Determines if the plugin is configurable.
PluginBase::__construct		public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.		82
StringTranslationTrait::$stringTranslation		protected	property	The string translation service.		3
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.		1
UnblockUser::access		public	function	Checks object access.	Overrides ActionInterface::access
UnblockUser::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.

Breadcrumb