WP_Customize_Control::check_capabilities(): bool
- Since
- 3.4.0
- Source
wp-includes/class-wp-customize-control.php:353
Description
Returns false if the user cannot manipulate one of the associated settings, or if one of the associated settings does not exist. Also returns false if the associated section does not exist or if its capability check returns false.
Compatibility
- WordPress
- since 3.4.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.
Return value
bool- False if theme doesn't support the control or user doesn't have the required permissions, otherwise true.
Performance profile
How much work a call to WP_Customize_Control::check_capabilities() 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
- Scaling
- Scales with input
- Instructions
- 8–25
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 33.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Control::check_capabilities() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($value) | 8 | none |
!empty($value) | 9–14 | current_user_can() |
empty($value) && !->check_capabilities() | 11 | ->check_capabilities() |
empty($value) && !isset($section) | 15–16 | ->get_section() |
!empty($value) && current_user_can() && !->check_capabilities() | 17 | current_user_can(), ->check_capabilities() |
empty($value) && isset($section) | 18–19 | ->get_section(), ->check_capabilities() |
!empty($value) && current_user_can() && !isset($section) | 21–22 | current_user_can(), ->get_section() |
!empty($value) && current_user_can() && isset($section) | 24–25 | current_user_can(), ->get_section(), ->check_capabilities() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 33 instructions, 8–25 executed per call, 8 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
- current_user_can()Returns whether the current user has the specified capability.
Used by · 1
- WP_Customize_Control::maybe_render()Check capabilities and render the control.
Source code
final public function check_capabilities() { if ( ! empty( $this->capability ) && ! current_user_can( $this->capability ) ) { return false; } foreach ( $this->settings as $setting ) { if ( ! $setting || ! $setting->check_capabilities() ) { return false; } } $section = $this->manager->get_section( $this->section ); if ( isset( $section ) && ! $section->check_capabilities() ) { return false; } return true; }Changelog
Introduced in 3.4.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 6.7.7 tag, from
src/wp-includes/class-wp-customize-control.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.