WP_Customize_Manager::validate_setting_values( array $setting_values, array $options = array() ): array

Description

Parameters

$setting_valuesarray

Mapping of setting IDs to values to validate and sanitize.

$optionsarrayoptional

Options.Default: array()

• $validate_existencebool

  Whether a setting's existence will be checked.

• $validate_capabilitybool

  Whether the setting capability will be checked.

Return

array

Mapping of setting IDs to return value of validate method calls, either true or WP_Error.

Hooks fired · 1

One hook fires while WP_Customize_Manager::validate_setting_values() runs, in this order:

1. 1
   apply_filters( customize_validate_{$setting->id} )filterline 2376 (+28 into the body)

Uses · 7

• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Customize_Manager::get_setting()Retrieves a customize setting.
• WP_Error::__construct()Initializes the error.

Used by · 2

• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.

Source

View on Trac ↗View on GitHub ↗

2348	public function validate_setting_values( $setting_values, $options = array() ) {2349		$options = wp_parse_args(2350			$options,2351			array(2352				'validate_capability' => false,2353				'validate_existence'  => false,2354			)2355		);2356 2357		$validities = array();2358		foreach ( $setting_values as $setting_id => $unsanitized_value ) {2359			$setting = $this->get_setting( $setting_id );2360			if ( ! $setting ) {2361				if ( $options['validate_existence'] ) {2362					$validities[ $setting_id ] = new WP_Error( 'unrecognized', __( 'Setting does not exist or is unrecognized.' ) );2363				}2364				continue;2365			}2366			if ( $options['validate_capability'] && ! current_user_can( $setting->capability ) ) {2367				$validity = new WP_Error( 'unauthorized', __( 'Unauthorized to modify setting due to capability.' ) );2368			} else {2369				if ( is_null( $unsanitized_value ) ) {2370					continue;2371				}2372				$validity = $setting->validate( $unsanitized_value );2373			}2374			if ( ! is_wp_error( $validity ) ) {2375				/** This filter is documented in wp-includes/class-wp-customize-setting.php */2376				$late_validity = apply_filters( "customize_validate_{$setting->id}", new WP_Error(), $unsanitized_value, $setting );2377				if ( is_wp_error( $late_validity ) && $late_validity->has_errors() ) {2378					$validity = $late_validity;2379				}2380			}2381			if ( ! is_wp_error( $validity ) ) {2382				$value = $setting->sanitize( $unsanitized_value );2383				if ( is_null( $value ) ) {2384					$validity = false;2385				} elseif ( is_wp_error( $value ) ) {2386					$validity = $value;2387				}2388			}2389			if ( false === $validity ) {2390				$validity = new WP_Error( 'invalid_value', __( 'Invalid value.' ) );2391			}2392			$validities[ $setting_id ] = $validity;2393		}2394		return $validities;2395	}

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.0.4 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.