WP_REST_Users_Controller::check_reassign() – Method

WP_REST_Users_Controller::check_reassign( int|bool $value, WP_REST_Request $request, string $param ): int|bool|WP_Error

Checks for a valid value for the reassign parameter when deleting users.

Description

The value can be an integer, ‘false’, false, or ''.

Parameters

$valueint|boolrequired: The value passed to the reassign parameter.
$requestWP_REST_Requestrequired: Full details about the request.
$paramstringrequired: The parameter that is being sanitized.

Return

int|bool|WP_Error

Source

public function check_reassign( $value, $request, $param ) {
	if ( is_numeric( $value ) ) {
		return $value;
	}

	if ( empty( $value ) || false === $value || 'false' === $value ) {
		return false;
	}

	return new WP_Error(
		'rest_invalid_param',
		__( 'Invalid user parameter(s).' ),
		array( 'status' => 400 )
	);
}

View all references View on Trac View on GitHub

Uses	Description
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.