WP_REST_Users_Controller::check_user_password() public WP 4.7.0
Check a user password for the REST API.
Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
{} It's a method of the class: WP_REST_Users_Controller{}
No Hooks.
Return
String/WP_Error. The sanitized password, if valid, otherwise an error.
Usage
$WP_REST_Users_Controller = new WP_REST_Users_Controller(); $WP_REST_Users_Controller->check_user_password( $value, $request, $param );
- $value(string) (required)
- The password submitted in the request.
- $request(WP_REST_Request) (required)
- Full details about the request.
- $param(string) (required)
- The parameter name.
Changelog
Since 4.7.0 | Introduced. |
Code of WP_REST_Users_Controller::check_user_password() WP REST Users Controller::check user password WP 5.6
public function check_user_password( $value, $request, $param ) {
$password = (string) $value;
if ( empty( $password ) ) {
return new WP_Error(
'rest_user_invalid_password',
__( 'Passwords cannot be empty.' ),
array( 'status' => 400 )
);
}
if ( false !== strpos( $password, '\\' ) ) {
return new WP_Error(
'rest_user_invalid_password',
sprintf(
/* translators: %s: The '\' character. */
__( 'Passwords cannot contain the "%s" character.' ),
'\\'
),
array( 'status' => 400 )
);
}
return $password;
}