WP_Theme_JSON::get_settings_values_by_slug( array $settings, array $preset_metadata, string[] $origins ): array

Description

$settings = array(
 'typography' => array(
 'fontFamilies' => array(
 array(
 'slug' => 'sansSerif',
 'fontFamily' => '"Helvetica Neue", sans-serif',
 ),
 array(
 'slug' => 'serif',
 'colors' => 'Georgia, serif',
 )
 ),
 ),
);
$meta = array(
 'path' => array( 'typography', 'fontFamilies' ),
 'value_key' => 'fontFamily',
);
$values_by_slug = get_settings_values_by_slug();
// $values_by_slug === array(
// 'sans-serif' => '"Helvetica Neue", sans-serif',
// 'serif' => 'Georgia, serif',
// );

Compatibility

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

Parameters

$settingsarray

Settings to process.

$preset_metadataarray

One of the PRESETS_METADATA values.

$originsstring[]

List of origins to process.

Return value

array

Array of presets where each key is a slug and each value is the preset value.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

15–16

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

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 WP_Theme_JSON::get_settings_values_by_slug() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• _wp_array_get()Accesses an array in depth based on a path of keys.
• _wp_to_kebab_case()This function is trying to replicate what lodash's kebabCase (JS library) does in the client.

Source code

View on Trac ↗View on GitHub ↗

2782	protected static function get_settings_values_by_slug( $settings, $preset_metadata, $origins ) {2783		$preset_per_origin = _wp_array_get( $settings, $preset_metadata['path'], array() );2784 2785		$result = array();2786		foreach ( $origins as $origin ) {2787			if ( ! isset( $preset_per_origin[ $origin ] ) ) {2788				continue;2789			}2790			foreach ( $preset_per_origin[ $origin ] as $preset ) {2791				$slug = _wp_to_kebab_case( $preset['slug'] );2792 2793				$value = '';2794				if ( isset( $preset_metadata['value_key'], $preset[ $preset_metadata['value_key'] ] ) ) {2795					$value_key = $preset_metadata['value_key'];2796					$value     = $preset[ $value_key ];2797				} elseif (2798					isset( $preset_metadata['value_func'] ) &&2799					is_callable( $preset_metadata['value_func'] )2800				) {2801					$value_func = $preset_metadata['value_func'];2802					$value      = call_user_func( $value_func, $preset, $settings );2803				} else {2804					// If we don't have a value, then don't add it to the result.2805					continue;2806				}2807 2808				$result[ $slug ] = $value;2809			}2810		}2811		return $result;2812	}

Changelog

Introduced in 5.9.0. 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 7.1.0 tag, from src/wp-includes/class-wp-theme-json.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.