wppaste
WordPress

WP_Customize_Manager::grant_edit_post_capability_for_changeset( string[] $caps, string $cap, int $user_id, array $args ): array

Since
4.9.0
Source
wp-includes/class-wp-customize-manager.php:3240
Re-maps 'edit_post' meta cap for a customize_changeset post to be the same as 'customize' maps.

Description

There is essentially a "meta meta" cap in play here, where 'edit_post' meta cap maps to the 'customize' meta cap which then maps to 'edit_theme_options'. This is currently required in core for wp_create_post_autosave() because it will call _wp_translate_postdata() which in turn will check if a user can 'edit_post', but the the caps for the customize_changeset post type are all mapping to the meta capability.
This should be able to be removed once #40922 is addressed in core.

Compatibility

WordPress
since 4.9.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

$capsstring[]
Array of the user's capabilities.
$capstring
Capability name.
$user_idint
The user ID.
$argsarray
Adds the context to the cap. Typically the object ID.

Return value

array
Capabilities.

Performance profile

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

Reaches the database via get_post().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
7–28

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

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 it touches

  • querycontent queryget_post()one call below WP_Customize_Manager::grant_edit_post_capability_for_changeset()
  • optionoption read or writeget_option()one call below WP_Customize_Manager::grant_edit_post_capability_for_changeset()
  • hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::grant_edit_post_capability_for_changeset()

Further down the call graph this can also reach cache, serialize 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 · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::grant_edit_post_capability_for_changeset() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always7–9none
$cap === "edit_post" && !empty($args)16get_post_type()
$cap === "edit_post" && !empty($args)28get_post_type(), get_post_type_object(), map_meta_cap()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 28 instructions, 7–28 executed per call, 3 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_post_type()Retrieves the post type of the current post or of a given post.
  • get_post_type_object()Retrieves a post type object by name.
  • map_meta_cap()Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.

Source code

View on Trac View on GitHub 

	public function grant_edit_post_capability_for_changeset( $caps, $cap, $user_id, $args ) {		if ( 'edit_post' === $cap && ! empty( $args[0] ) && 'customize_changeset' === get_post_type( $args[0] ) ) {			$post_type_obj = get_post_type_object( 'customize_changeset' );			$caps          = map_meta_cap( $post_type_obj->cap->$cap, $user_id );		}		return $caps;	}

Changelog

Introduced in 4.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 6.8.8 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.