WP_View_Config_Data::merge( array $patch, int $version ): WP_View_Config_Data
- Since
- 7.1.0
- Source
wp-includes/class-wp-view-config-data.php:384
Description
Applies a patch of top-level keys and touches only the keys the patch names: a key the patch omits keeps whatever it had, and a null value drops the key it names (which resets it to its default). Each named key's value is then merged into the current one by value shape:
- a scalar replaces the current value;
- an associative array merges key by key, with a nested
nulldeleting just the leaf it names; - a list merges into the current list by member identity.
Identity is the member's value cast to a string: a bare scalar is its own identity, and a map is identified by the value of the first of the well-known identity keys (id, slug, field) it carries. A member whose identity matches one already present merges into it in place, keeping its position; a member with no identity is appended to the end of the list.
For example, given this patch:
array(
'default_view' => array( 'titleField' => 'newTitleField', 'fields' => array( 'newField' ) ),
'default_layouts' => array( 'grid' => array( 'layout' => array( 'badgeFields' => array( 'newField' ) ) ) ),
'view_list' => array( array( 'slug' => 'table', 'title' => 'New title' ) ),
) - default_view will be updated so the titleField is 'newTitleField' and the newField is appended to the list of fields.
- default_layouts will be updated so that newField is appended to the badgeFields.
- view_list will be updated so that the view with slug 'table' has its title changed to 'New title'.
A patch value only merges into a current value of the same shape: an associative array where a list lives, or a non-empty list where an associative value lives, is rejected with a notice and leaves the current value unchanged. An empty array merges nothing and is a no-op — clear a list with replace() and an empty list, or reset a key to its default with a top-level null.
A patch that declares an unsupported schema version is rejected and does not change anything.
Compatibility
- WordPress
- since 7.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 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$patcharray- The partial configuration to merge.
$versionint- The schema version the patch was authored against.
Return value
WP_View_Config_Data- The instance, for chaining.
Performance profile
How much work a call to WP_View_Config_Data::merge() 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
- 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. The body compiles to 9.
Nothing here hands control to plugin code.
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_View_Config_Data::merge() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9 | ->apply() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 executed per call, 0 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 · 1
- WP_View_Config_Data::apply()Applies a patch to the configuration, top-level key by top-level key.
Source code
public function merge( array $patch, int $version ) { return $this->apply( $patch, $version, __METHOD__, 'merge' ); }Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-view-config-data.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.