WP_Customize_Manager::post_value( WP_Customize_Setting $setting, mixed $default_value = null ): string|mixed
- Since
- 3.4.0, 4.1.1, 4.6.0
- Source
wp-includes/class-wp-customize-manager.php:1835
Description
The name "post_value" is a carry-over from when the customized state was exclusively sourced from $_POST['customized']. Nevertheless, the value returned will come from the current changeset post and from the incoming post data.
Compatibility
- WordPress
- since 4.6.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$settingWP_Customize_Setting- A WP_Customize_Setting derived object.
$default_valuemixedoptional- Value returned if
$settinghas no post value (added in 4.2.0) or the post value is invalid (added in 4.6.0).Default:null
Return value
string|mixed- Sanitized value or the
$default_valueprovided.
Performance profile
How much work a call to WP_Customize_Manager::post_value() 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
- Scaling
- Constant
- Instructions
- 9–29
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below WP_Customize_Manager::post_value()
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_Manager::post_value() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$post_values | 9 | ->unsanitized_post_values() |
$post_values && is_wp_error() | 19 | ->unsanitized_post_values(), ->validate(), is_wp_error() |
$post_values && !is_wp_error() && $value === null | 25 | ->unsanitized_post_values(), ->validate(), is_wp_error(), ->sanitize() |
$post_values && !is_wp_error() && $value !== null | 29 | ->unsanitized_post_values(), ->validate(), is_wp_error(), ->sanitize(), is_wp_error() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 32 instructions, 9–29 executed per call, 4 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- is_wp_error()Checks whether the given variable is a WordPress Error.
- WP_Customize_Manager::unsanitized_post_values()Gets dirty pre-sanitized setting values in the current customized state.
Source code
public function post_value( $setting, $default_value = null ) { $post_values = $this->unsanitized_post_values(); if ( ! array_key_exists( $setting->id, $post_values ) ) { return $default_value; } $value = $post_values[ $setting->id ]; $valid = $setting->validate( $value ); if ( is_wp_error( $valid ) ) { return $default_value; } $value = $setting->sanitize( $value ); if ( is_null( $value ) || is_wp_error( $value ) ) { return $default_value; } return $value; }Changelog
Introduced in 4.1.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$default_value is now returned early when the setting post value is invalid.from the docblock$default_value parameter.from the docblockAbout 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.