WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

customize_validate_{$this->id}

apply_filters( “customize_validate_{$this->id}”, WP_Error $validity, mixed $value, WP_Customize_Setting $setting )

In this article

Back to top

Validates a Customize setting value.

Description

Plugins should amend the $validity object via its WP_Error::add() method.

The dynamic portion of the hook name, $this->ID, refers to the setting ID.

Parameters

$validityWP_Error
Filtered from true to WP_Error when invalid.
$valuemixed
Value of the setting.
$settingWP_Customize_Setting
WP_Customize_Setting instance.

Source

$validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );

View all references View on Trac View on GitHub

Used byDescription
WP_Customize_Setting::validate()wp-includes/class-wp-customize-setting.php

Validates an input.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

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