wppaste
WordPress

WP_User::_init_caps( string $cap_key = '' )

Since
2.1.0
Source
wp-includes/class-wp-user.php:482
Sets up capability object properties.

Description

Will set the value for the 'cap_key' property to current database table prefix, followed by 'capabilities'. Will then check to see if the property matching the 'cap_key' exists and is an array. If so, it will be used.

Compatibility

Deprecated in WordPress 4.9.0. Use WP_User::for_site()

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

$cap_keystringoptional
Optional capability keyDefault: ''

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
18–25

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksdo_action()one call below WP_User::_init_caps()

Further down the call graph this can also reach query, option, 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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!empty($cap_key)18_deprecated_function(), ->get_caps_data(), ->get_role_caps()
empty($cap_key)25_deprecated_function(), ->get_blog_prefix(), ->get_caps_data(), ->get_role_caps()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 27 instructions, 18–25 executed per call, 1 branch. 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

Used by · 1

  • WP_User::__call()Makes private/protected methods readable for backward compatibility.

Source code

View on Trac View on GitHub 

	protected function _init_caps( $cap_key = '' ) {		global $wpdb; 		_deprecated_function( __METHOD__, '4.9.0', 'WP_User::for_site()' ); 		if ( empty( $cap_key ) ) {			$this->cap_key = $wpdb->get_blog_prefix( $this->site_id ) . 'capabilities';		} else {			$this->cap_key = $cap_key;		} 		$this->caps = $this->get_caps_data(); 		$this->get_role_caps();	}

Changelog

Introduced in 2.1.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.

4.9.0
Deprecated. Use WP_User::for_site()from the docblock
2.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-user.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.