5 views 
Summery Summery
Check a user password for the REST API.
Syntax Syntax
Description Description
Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
Parameters Parameters
- $value
-
(Required) The password submitted in the request.
- $request
-
(Required) Full details about the request.
- $param
-
(Required) The parameter name.
Return Return
(string|WP_Error) The sanitized password, if valid, otherwise an error.
Source Source
File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
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',
__( 'Passwords cannot contain the "\\" character.' ),
array( 'status' => 400 )
);
}
return $password;
}
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |