rest_format_combining_operation_error() │ WP 5.6.0

Formats a combining operation error into a WP_Error object.

No Hooks.

Return

WP_Error.

Usage

rest_format_combining_operation_error( $param, $error );

$param(string) (required)

The parameter name.

$error(array) (required)

The error details.

Changelog

rest_format_combining_operation_error() rest format combining operation error code ^{WP 6.6.2}

function rest_format_combining_operation_error( $param, $error ) {
	$position = $error['index'];
	$reason   = $error['error_object']->get_error_message();

	if ( isset( $error['schema']['title'] ) ) {
		$title = $error['schema']['title'];

		return new WP_Error(
			'rest_no_matching_schema',
			/* translators: 1: Parameter, 2: Schema title, 3: Reason. */
			sprintf( __( '%1$s is not a valid %2$s. Reason: %3$s' ), $param, $title, $reason ),
			array( 'position' => $position )
		);
	}

	return new WP_Error(
		'rest_no_matching_schema',
		/* translators: 1: Parameter, 2: Reason. */
		sprintf( __( '%1$s does not match the expected format. Reason: %2$s' ), $param, $reason ),
		array( 'position' => $position )
	);
}