__get_option( string $setting ): mixed
- Since
- 1.5.1
- Source
wp-admin/includes/upgrade.php:2865
Compatibility
- WordPress
- since 1.5.1
- 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
$settingstring- Option name.
Return value
mixed- Option value.
Performance profile
How much work a call to __get_option() 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
- Scaling
- Constant
- Instructions
- 11–35
- Plugin surface
- None
- Called by
- 9
Reaches the database via ->get_var().
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 49.
Nothing here hands control to plugin code.
9 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- serializeserialisation
maybe_unserialize()called directly - sqldatabase query
->get_var()called directly
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 __get_option() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11–15 | untrailingslashit() |
$setting === "home" | 25–29 | ->prepare(), ->get_var(), __get_option() |
!$setting | 26–31 | ->prepare(), ->get_var(), maybe_unserialize() |
$setting | 30–35 | ->prepare(), ->get_var(), untrailingslashit(), maybe_unserialize() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 49 instructions, 11–35 executed per call, 7 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 · 3
- untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
- __get_option()Utility version of get_option that is private to installation/upgrade.
- maybe_unserialize()Unserializes data only if it was serialized.
Used by · 9
- __get_option()Utility version of get_option that is private to installation/upgrade.
- make_site_theme()Creates a site theme.
- make_site_theme_from_default()Creates a site theme from the default theme.
- make_site_theme_from_oldschool()Creates a site theme from an existing theme.
- maybe_disable_automattic_widgets()Disables the Automattic widgets plugin, which was merged into core.
- populate_options()Create WordPress options and set the default values.
- upgrade_130()Execute changes made in WordPress 1.5.
- upgrade_all()Functions to be called in installation and upgrade scripts.
- wp_upgrade()Runs WordPress Upgrade functions.
Source code
function __get_option( $setting ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore global $wpdb; if ( 'home' === $setting && defined( 'WP_HOME' ) ) { return untrailingslashit( WP_HOME ); } if ( 'siteurl' === $setting && defined( 'WP_SITEURL' ) ) { return untrailingslashit( WP_SITEURL ); } $option = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s", $setting ) ); if ( 'home' === $setting && ! $option ) { return __get_option( 'siteurl' ); } if ( in_array( $setting, array( 'siteurl', 'home', 'category_base', 'tag_base' ), true ) ) { $option = untrailingslashit( $option ); } return maybe_unserialize( $option );}Changelog
Introduced in 1.5.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-admin/includes/upgrade.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.