Filter

rp_api_token_generate_error_message

Updated 30 Oct 2026

On this page

Parameters
Return value
Example
Notes
Source
See also

Filters error messages returned while generating a REST API token.

Used in the REST auth controller for the message returned when the token claims are not an array, when JWT encoding throws an exception (the message is the translated exception text), and in the permission check when the user is not logged in, not allowed to edit the requested user, or no API key is available.

Parameters#

Parameter	Type	Description
`$message`	`string`	The error message.

Return value#

string. The error message.

Example#

function my_token_error_message( $message ) {
	return __( 'Token request failed.', 'my-textdomain' );
}
add_filter( 'rp_api_token_generate_error_message', 'my_token_error_message' );

Notes#

The three permission-check call sites pass the WP_REST_Request as a second argument; the other call sites pass only the message.

Source#

Applied in:

includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 157), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 170), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 175), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 180), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 185), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 190), in RP_REST_Auth_V1_Controller::get_token()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 237), in RP_REST_Auth_V1_Controller::get_auth_permissions_check()
includes/rest-api/Controllers/Version1/class-rp-rest-auth-v1-controller.php (line 245), in RP_REST_Auth_V1_Controller::get_auth_permissions_check()
and 1 more places.