WP_Customize_Setting::validate( mixed $value ): true|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$valuemixed

Value to validate.

Return value

true|WP_Error

True if the input was validated, otherwise WP_Error.

Performance profile

How much work a call to WP_Customize_Setting::validate() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

6–29

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.

Plugin surface

1 hook

Third-party callbacks on 'customize_validate_{$this->id}' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Setting::validate() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Customize_Setting::validate() runs, in this order:

1. 1
   apply_filters( customize_validate_{$this->id} )filterline 612 (+23 into the body)

   Validates a Customize setting value.

Uses · 4

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Customize_Custom_CSS_Setting::validate()Validate a received value for being valid CSS.

Source code

View on Trac ↗View on GitHub ↗

589	public function validate( $value ) {590		if ( is_wp_error( $value ) ) {591			return $value;592		}593		if ( is_null( $value ) ) {594			return new WP_Error( 'invalid_value', __( 'Invalid value.' ) );595		}596 597		$validity = new WP_Error();598 599		/**600		 * Validates a Customize setting value.601		 *602		 * Plugins should amend the `$validity` object via its `WP_Error::add()` method.603		 *604		 * The dynamic portion of the hook name, `$this->ID`, refers to the setting ID.605		 *606		 * @since 4.6.0607		 *608		 * @param WP_Error             $validity Filtered from `true` to `WP_Error` when invalid.609		 * @param mixed                $value    Value of the setting.610		 * @param WP_Customize_Setting $setting  WP_Customize_Setting instance.611		 */612		$validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );613 614		if ( is_wp_error( $validity ) && ! $validity->has_errors() ) {615			$validity = true;616		}617		return $validity;618	}

Changelog

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 6.7.7 tag, from src/wp-includes/class-wp-customize-setting.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.