wp_xmlrpc_server::wp_getTaxonomies( array $args ): array|IXR_Error
- Since
- 3.4.0
- Source
wp-includes/class-wp-xmlrpc-server.php:2609
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.
Parameters
$argsarray- Method arguments. Note: arguments must be ordered as documented.
$0intBlog ID (unused).$1stringUsername.$2stringPassword.$3arrayOptional. An array of arguments for retrieving taxonomies.$4arrayOptional. The subset of taxonomy fields to return.
Return value
array|IXR_Error- An associative array of taxonomy data with returned fields determined by
$fields, or an IXR_Error instance on failure.
Performance profile
How much work a call to wp_xmlrpc_server::wp_getTaxonomies() 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–47
- Plugin surface
- 2 hooks
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 68.
Third-party callbacks on 'xmlrpc_default_taxonomy_fields', 'xmlrpc_call' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_getTaxonomies() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->minimum_args() | 8 | ->minimum_args() |
->minimum_args() && isset($args) | 27–28 | ->minimum_args(), ->escape(), ->login() |
->minimum_args() && !isset($args) | 31–32 | ->minimum_args(), ->escape(), apply_filters(), ->login() |
->minimum_args() && isset($args) | 41–43 | ->minimum_args(), ->escape(), ->login(), do_action(), get_taxonomies() |
->minimum_args() && !isset($args) | 45–47 | ->minimum_args(), ->escape(), apply_filters(), ->login(), do_action(), get_taxonomies() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 68 | 8–47 | 7 | |
| 8.5 | 68 | 8–47 | 7 | |
| 8.4 | 68 | 8–47 | 7 | |
| 8.3 | 68 | 8–47 | 7 | |
| 8.2 | 68 | 8–47 | 7 | |
| 8.1 | 68 | 8–47 | 7 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 69 | 8–48 | 7 |
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.
Hooks and filters fired · 2
2 hooks fire while wp_xmlrpc_server::wp_getTaxonomies() runs, in this order:
- apply_filters( xmlrpc_default_taxonomy_fields )filterline 2624 (+15 into the body)
Filters the default taxonomy query fields used by the given XML-RPC method.
- do_action( xmlrpc_call )actionline 2633 (+24 into the body)
Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
Uses · 8
- apply_filters()Calls the callback functions that have been added to a filter hook.
- do_action()Calls the callback functions that have been added to an action hook.
- get_taxonomies()Retrieves a list of registered taxonomy names or objects.
- current_user_can()Returns whether the current user has the specified capability.
- wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
- wp_xmlrpc_server::escape()Escapes string or array of strings for database.
- wp_xmlrpc_server::login()Logs user in.
- wp_xmlrpc_server::_prepare_taxonomy()Prepares taxonomy data for return in an XML-RPC object.
Source code
public function wp_getTaxonomies( $args ) { if ( ! $this->minimum_args( $args, 3 ) ) { return $this->error; } $this->escape( $args ); $username = $args[1]; $password = $args[2]; $filter = isset( $args[3] ) ? $args[3] : array( 'public' => true ); if ( isset( $args[4] ) ) { $fields = $args[4]; } else { /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomies' ); } $user = $this->login( $username, $password ); if ( ! $user ) { return $this->error; } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getTaxonomies', $args, $this ); $taxonomies = get_taxonomies( $filter, 'objects' ); // Holds all the taxonomy data. $struct = array(); foreach ( $taxonomies as $taxonomy ) { // Capability check for post types. if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) { continue; } $struct[] = $this->_prepare_taxonomy( $taxonomy, $fields ); } return $struct; }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.8.8 tag, from
src/wp-includes/class-wp-xmlrpc-server.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.