class UserIsBlocked

Provides a 'User is blocked' condition.

@todo Add access callback information from Drupal 7.

Plugin annotation

@Condition(
  id = "rules_user_is_blocked",
  label = @Translation("User is blocked"),
  category = @Translation("User"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      description = @Translation("Specifies the user account to check.")
    ),
  }
)

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\Executable\ExecutablePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait
      • class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
        • class \Drupal\rules\Core\RulesConditionBase extends \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
          • class \Drupal\rules\Plugin\Condition\UserIsBlocked extends \Drupal\rules\Core\RulesConditionBase

Expanded class hierarchy of UserIsBlocked

File

src/Plugin/Condition/UserIsBlocked.php, line 25

Namespace

class UserIsBlocked extends RulesConditionBase {
    
    /**
     * Check if user is blocked.
     *
     * @param \Drupal\user\UserInterface $user
     *   The account to check.
     *
     * @return bool
     *   TRUE if the account is blocked.
     */
    protected function doEvaluate(UserInterface $user) {
        return $user->isBlocked();
    }

}

Members