WP_Customize_Widgets::capture_filter_pre_update_option() – Method

WP_Customize_Widgets::capture_filter_pre_update_option( mixed $new_value, string $option_name, mixed $old_value ): mixed

Pre-filters captured option values before updating.

Parameters

$new_valuemixedrequired: The new option value.
$option_namestringrequired: Name of the option.
$old_valuemixedrequired: The old option value.

Return

mixed Filtered option value.

Source

public function capture_filter_pre_update_option( $new_value, $option_name, $old_value ) {
	if ( $this->is_option_capture_ignored( $option_name ) ) {
		return $new_value;
	}

	if ( ! isset( $this->_captured_options[ $option_name ] ) ) {
		add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
	}

	$this->_captured_options[ $option_name ] = $new_value;

	return $old_value;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Customize_Widgets::is_option_capture_ignored()`wp-includes/class-wp-customize-widgets.php`	Determines whether the captured option update should be ignored.
add_filter()`wp-includes/plugin.php`	Adds a callback function to a filter hook.

Changelog

Version	Description
3.9.0	Introduced.

User Contributed Notes

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