WP_Customize_Manager::unsanitized_post_values( array $args = array() ): array

Description

Compatibility

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

Parameters

$argsarrayoptional

Args.Default: array()

• $exclude_changesetbool

  Whether the changeset values should also be excluded. Defaults to false.

• $exclude_post_databool

  Whether the post input values should also be excluded. Defaults to false when lacking the customize capability.

Return value

array

Performance profile

How much work a call to WP_Customize_Manager::unsanitized_post_values() 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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

21–74

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

7

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

What it touches

• optionoption read or writeget_option()called directly
• serializeserialisationjson_decode()called directly
• hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::unsanitized_post_values()
• cacheobject cachewp_cache_get()one call below WP_Customize_Manager::unsanitized_post_values()

Further down the call graph this can also reach query 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 · 18 distinct outcomes

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

Uses · 7

• current_user_can()Returns whether the current user has the specified capability.
• get_option()Retrieves an option value based on an option name.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• WP_Customize_Manager::is_theme_active()Checks if the current theme is active.
• WP_Customize_Manager::get_stylesheet()Retrieves the stylesheet name of the previewed theme.
• WP_Customize_Manager::changeset_data()Gets changeset data.

Used by · 7

• WP_Customize_Manager::_publish_changeset_values()Publishes the values of a changeset.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::post_value()Returns the sanitized value for a given setting from the current customized state.
• WP_Customize_Manager::register_dynamic_settings()Adds settings from the POST data that were not added with code, e.g. dynamically-created settings for Widgets
• WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
• WP_Customize_Manager::set_post_value()Overrides a setting's value in the current customized state.

Source code

View on Trac ↗View on GitHub ↗

1759	public function unsanitized_post_values( $args = array() ) {1760		$args = array_merge(1761			array(1762				'exclude_changeset' => false,1763				'exclude_post_data' => ! current_user_can( 'customize' ),1764			),1765			$args1766		);1767 1768		$values = array();1769 1770		// Let default values be from the stashed theme mods if doing a theme switch and if no changeset is present.1771		if ( ! $this->is_theme_active() ) {1772			$stashed_theme_mods = get_option( 'customize_stashed_theme_mods' );1773			$stylesheet         = $this->get_stylesheet();1774			if ( isset( $stashed_theme_mods[ $stylesheet ] ) ) {1775				$values = array_merge( $values, wp_list_pluck( $stashed_theme_mods[ $stylesheet ], 'value' ) );1776			}1777		}1778 1779		if ( ! $args['exclude_changeset'] ) {1780			foreach ( $this->changeset_data() as $setting_id => $setting_params ) {1781				if ( ! array_key_exists( 'value', $setting_params ) ) {1782					continue;1783				}1784				if ( isset( $setting_params['type'] ) && 'theme_mod' === $setting_params['type'] ) {1785 1786					// Ensure that theme mods values are only used if they were saved under the active theme.1787					$namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/';1788					if ( preg_match( $namespace_pattern, $setting_id, $matches ) && $this->get_stylesheet() === $matches['stylesheet'] ) {1789						$values[ $matches['setting_id'] ] = $setting_params['value'];1790					}1791				} else {1792					$values[ $setting_id ] = $setting_params['value'];1793				}1794			}1795		}1796 1797		if ( ! $args['exclude_post_data'] ) {1798			if ( ! isset( $this->_post_values ) ) {1799				if ( isset( $_POST['customized'] ) ) {1800					$post_values = json_decode( wp_unslash( $_POST['customized'] ), true );1801				} else {1802					$post_values = array();1803				}1804				if ( is_array( $post_values ) ) {1805					$this->_post_values = $post_values;1806				} else {1807					$this->_post_values = array();1808				}1809			}1810			$values = array_merge( $values, $this->_post_values );1811		}1812		return $values;1813	}

Changelog

Introduced in 4.1.1. 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.9.7 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.