class UserUnblock

Provides "Unblock User" action.

@todo Add access callback information from Drupal 7.

Plugin annotation

@RulesAction(
  id = "rules_user_unblock",
  label = @Translation("Unblock a user"),
  category = @Translation("User"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      description = @Translation("Specifies the user that should be unblocked.")
    ),
  }
)

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\rules\Core\RulesActionBase extends \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\rules\Plugin\RulesAction\UserUnblock implements \Drupal\rules\Core\RulesActionBase

Expanded class hierarchy of UserUnblock

File

src/Plugin/RulesAction/UserUnblock.php, line 25

Namespace

class UserUnblock extends RulesActionBase {
  
  /**
   * Flag that indicates if the entity should be auto-saved later.
   *
   * @var bool
   */
  protected $saveLater = FALSE;
  
  /**
   * Unblock a user.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to unblock.
   */
  protected function doExecute(UserInterface $user) {
    // Do nothing if user is anonymous or isn't blocked.
    if ($user->isAuthenticated() && $user->isBlocked()) {
      $user->activate();
      // Set flag that indicates if the entity should be auto-saved later.
      $this->saveLater = TRUE;
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function autoSaveContext() {
    if ($this->saveLater) {
      return [
        'user',
      ];
    }
    return [];
  }

}

Members