WP_Ability::validate_input( mixed $input = null ): true|WP_Error

In this article

Validates input data against the input schema.

Parameters

$inputmixedoptional
The input data to validate.

Default:null

Return

true|WP_Error Returns true if valid or the WP_Error object if validation fails.

Source

public function validate_input( $input = null ) {
	$input_schema = $this->get_input_schema();
	if ( empty( $input_schema ) ) {
		if ( null === $input ) {
			return true;
		}

		return new WP_Error(
			'ability_missing_input_schema',
			sprintf(
				/* translators: %s ability name. */
				__( 'Ability "%s" does not define an input schema required to validate the provided input.' ),
				esc_html( $this->name )
			)
		);
	}

	$valid_input = rest_validate_value_from_schema( $input, $input_schema, 'input' );
	if ( is_wp_error( $valid_input ) ) {
		return new WP_Error(
			'ability_invalid_input',
			sprintf(
				/* translators: %1$s ability name, %2$s error message. */
				__( 'Ability "%1$s" has invalid input. Reason: %2$s' ),
				esc_html( $this->name ),
				$valid_input->get_error_message()
			)
		);
	}

	return true;
}

Changelog

VersionDescription
6.9.0Introduced.

User Contributed Notes

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