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

Description

Parameters

$validitytrue|WP_Error

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.

Uses · 1

• is_wp_error()Checks whether the given variable is a WordPress Error.

Source

View on Trac ↗View on GitHub ↗

2410	public function prepare_setting_validity_for_js( $validity ) {2411		if ( is_wp_error( $validity ) ) {2412			$notification = array();2413			foreach ( $validity->errors as $error_code => $error_messages ) {2414				$notification[ $error_code ] = array(2415					'message' => implode( ' ', $error_messages ),2416					'data'    => $validity->get_error_data( $error_code ),2417				);2418			}2419			return $notification;2420		} else {2421			return true;2422		}2423	}

History

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-customize-manager.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.