WP_Customize_Manager::prepare_setting_validity_for_js() – Method

WP_Customize_Manager::prepare_setting_validity_for_js( true|WP_Error $validity ): true|array

Prepares setting validity for exporting to the client (JS).

Description

Converts WP_Error instance into array suitable for passing into the wp.customize.Notification JS model.

Parameters

$validitytrue|WP_Errorrequired: Setting validity.

Return

true|array If $validity was a WP_Error, the error codes will be array-mapped to their respective message and data to pass into the wp.customize.Notification JS model.

Source

public function prepare_setting_validity_for_js( $validity ) {
	if ( is_wp_error( $validity ) ) {
		$notification = array();
		foreach ( $validity->errors as $error_code => $error_messages ) {
			$notification[ $error_code ] = array(
				'message' => implode( ' ', $error_messages ),
				'data'    => $validity->get_error_data( $error_code ),
			);
		}
		return $notification;
	} else {
		return true;
	}
}

View all references View on Trac View on GitHub

Uses	Description
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Changelog

Version	Description
4.6.0	Introduced.

User Contributed Notes

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