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

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


Description Description

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


Top ↑

Parameters Parameters

$value

(int|bool) (Required) The value passed to the reassign parameter.

$request

(WP_REST_Request) (Required) Full details about the request.

$param

(string) (Required) The parameter that is being sanitized.


Top ↑

Return Return

(int|bool|WP_Error)


Top ↑

Source Source

File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

	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 )
		);
	}


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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