WP_REST_View_Config_Controller::get_required_capability( string $kind, string $name ): string|null
- Since
- 7.1.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php:116
Description
Known kinds map to the capability that gates managing that entity's list: post types use their own edit_posts capability (which honors custom capability_type registrations), taxonomies use manage_terms, and root-level entities use manage_options. A post type or taxonomy that is not registered, or not exposed to the REST API, resolves to null so the request is treated as referencing an unknown entity.
Any other kind falls back to edit_posts. This keeps entities registered through the get_entity_view_config_{$kind}_{$name} filter readable behind a baseline capability.
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
$kindstring- The entity kind (e.g.
postType). $namestring- The entity name (e.g.
page).
Return value
string|null- Capability required to read the config, or null if the entity is not registered.
Performance profile
How much work a call to WP_REST_View_Config_Controller::get_required_capability() 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
- 4–17
- Plugin surface
- None
- Called by
- 1
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, depending on the branch taken. The body compiles to 34.
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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_View_Config_Controller::get_required_capability() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 4–10 | none |
| always | 9–15 | get_post_type_object() |
| always | 9–17 | get_taxonomy() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 34 | 4–17 | 8 | |
| 8.5 | 34 | 4–17 | 8 | |
| 8.4 | 34 | 4–17 | 8 | |
| 8.3 | 34 | 4–17 | 8 | |
| 8.2 | 34 | 4–17 | 8 | |
| 8.1 | 34 | 4–17 | 8 | 1 more instruction than PHP 7.4 |
| 7.4 | 33 | 4–19 | 8 |
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 · 2
- get_post_type_object()Retrieves a post type object by name.
- get_taxonomy()Retrieves the taxonomy object of $taxonomy.
Used by · 1
- WP_REST_View_Config_Controller::get_items_permissions_check()Checks if a given request has access to read view config.
Source code
protected function get_required_capability( $kind, $name ) { switch ( $kind ) { case 'postType': $post_type = get_post_type_object( $name ); if ( $post_type && $post_type->show_in_rest ) { return $post_type->cap->edit_posts; } return null; case 'taxonomy': $taxonomy = get_taxonomy( $name ); if ( $taxonomy && $taxonomy->show_in_rest ) { return $taxonomy->cap->manage_terms; } return null; case 'root': return 'manage_options'; } return 'edit_posts'; }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/rest-api/endpoints/class-wp-rest-view-config-controller.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.