UserPassword
Edit this pageWarning: You are browsing the documentation for Symfony 3.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
UserPassword
This validates that an input value is equal to the current authenticated user's password. This is useful in a form where a user can change their password, but needs to enter their old password for security.
Note
This should not be used to validate a login form, since this is done automatically by the security system.
| Applies to | property or method |
| Options | |
| Class | UserPassword |
| Validator | UserPasswordValidator |
Basic Usage
Suppose you have a ChangePassword class, that's used in a form where
the user can change their password by entering their old password and a
new password. This constraint will validate that the old password matches
the user's current password:
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Form/Model/ChangePassword.php
namespace AppBundle\Form\Model;
use Symfony\Component\Security\Core\Validator\Constraints as SecurityAssert;
class ChangePassword
{
/**
* @SecurityAssert\UserPassword(
* message = "Wrong value for your current password"
* )
*/
protected $oldPassword;
}Options
message
type: message default: This value should be the user current password.
This is the message that's displayed when the underlying string does not match the current user's password.
payload
type: mixed default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
