UserNameConstraint.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraint.php
  2. 8.9.x core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraint.php
  3. 10 core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraint.php

Namespace

Drupal\user\Plugin\Validation\Constraint

File

core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraint.php

View source
<?php

namespace Drupal\user\Plugin\Validation\Constraint;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Validation\Attribute\Constraint;
use Symfony\Component\Validator\Constraint as SymfonyConstraint;

/**
 * Checks if a value is a valid user name.
 */
class UserNameConstraint extends SymfonyConstraint {
    
    /**
     * The violation message when there is no username.
     *
     * @var string
     */
    public $emptyMessage = 'You must enter a username.';
    
    /**
     * The violation message when the username begins with whitespace.
     *
     * @var string
     */
    public $spaceBeginMessage = 'The username cannot begin with a space.';
    
    /**
     * The violation message when the username ends with whitespace.
     *
     * @var string
     */
    public $spaceEndMessage = 'The username cannot end with a space.';
    
    /**
     * The violation message when the username has consecutive whitespace.
     *
     * @var string
     */
    public $multipleSpacesMessage = 'The username cannot contain multiple spaces in a row.';
    
    /**
     * The violation message when the username uses an invalid character.
     *
     * @var string
     */
    public $illegalMessage = 'The username contains an illegal character.';
    
    /**
     * The violation message when the username length exceeds the maximum allowed.
     *
     * @var string
     */
    public $tooLongMessage = 'The username %name is too long: it must be %max characters or less.';

}

Classes

Title Deprecated Summary
UserNameConstraint Checks if a value is a valid user name.

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