Featured_Content::get_setting( string $key = 'all' ): mixed
- Since
- Twenty Fourteen 1.0
- Source
wp-content/themes/twentyfourteen/inc/featured-content.php:458
Description
Gets all settings recognized by this module. This function will return all settings whether or not they have been stored in the database yet. This ensures that all keys are available at all times.
In the event that you only require one setting, you may pass its name as the first parameter to the function and only that value will be returned.
Compatibility
- WordPress
- since Twenty Fourteen 1.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
$keystringoptional- The key of a recognized setting.Default:
'all'
Return value
mixed- Array of all settings by default. A single value if passed as first parameter.
Performance profile
How much work a call to Featured_Content::get_setting() 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
- Moderate
- Scaling
- Constant
- Instructions
- 27–30
- Plugin surface
- None
- Called by
- 5
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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.
5 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()one call below Featured_Content::get_setting() - cacheobject cache
wp_cache_get()one call below Featured_Content::get_setting() - serializeserialisation
maybe_unserialize()one call below Featured_Content::get_setting()
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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost Featured_Content::get_setting() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 27–30 | get_option(), _x(), wp_parse_args(), array_intersect_key() |
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, 27–30 executed per call, 2 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
- get_option()Retrieves an option value based on an option name.
- _x()Retrieves translated string with gettext context.
- wp_parse_args()Merges user defined arguments into defaults array.
Used by · 5
- Featured_Content::delete_post_tag()Resets tag option when the saved tag is deleted.
- Featured_Content::get_featured_post_ids()Gets featured post IDs.
- Featured_Content::hide_featured_term()Hides featured tag from displaying when global terms are queried from the front end.
- Featured_Content::hide_the_featured_term()Hides featured tag from display when terms associated with a post object are queried from the front end.
- Featured_Content::wp_loaded()Hides "featured" tag from the front end.
Source code
public static function get_setting( $key = 'all' ) { $saved = (array) get_option( 'featured-content' ); $defaults = array( 'hide-tag' => 1, 'tag-id' => 0, 'tag-name' => _x( 'featured', 'featured content default tag slug', 'twentyfourteen' ), ); $options = wp_parse_args( $saved, $defaults ); $options = array_intersect_key( $options, $defaults ); if ( 'all' !== $key ) { return isset( $options[ $key ] ) ? $options[ $key ] : false; } return $options; }Changelog
Introduced in Twenty Fourteen 1.0. 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-content/themes/twentyfourteen/inc/featured-content.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.