wp_xmlrpc_server::wp_getMediaLibrary( array $args ): array|IXR_Error
- Since
- 3.1.0
- Source
wp-includes/class-wp-xmlrpc-server.php:4432
Description
Besides the common blog_id (unused), username, and password arguments, it takes a filter array as the last argument.
Accepted 'filter' keys are 'parent_id', 'mime_type', 'offset', and 'number'.
The defaults are as follows:
- 'number' - Default is 5. Total number of media items to retrieve.
- 'offset' - Default is 0. See WP_Query::query() for more.
- 'parent_id' - Default is ''. The post where the media item is attached.
Empty string shows all media items. 0 shows unattached media items. - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf')
Compatibility
- WordPress
- since 3.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
$argsarray- Method arguments. Note: arguments must be ordered as documented.
$0intBlog ID (unused).$1stringUsername.$2stringPassword.$3arrayOptional. Query arguments.
Return value
array|IXR_Error- Array containing a collection of media items.
See wp_xmlrpc_server::wp_getMediaItem() for a description of each item contents.
Performance profile
How much work a call to wp_xmlrpc_server::wp_getMediaLibrary() 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
- Scaling
- Scales with input
- Instructions
- 17–75
- Plugin surface
- 1 hook
- Called by
- 0
Reaches the database via get_posts().
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 94.
Third-party callbacks on '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
do_action()called directly - querycontent query
get_posts()called directly
Further down the call graph this can also reach 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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_getMediaLibrary() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17–18 | ->escape(), ->login() |
!current_user_can() | 27–28 | ->escape(), ->login(), current_user_can(), __() |
current_user_can() && !isset($struct) | 54–57 | ->escape(), ->login(), current_user_can(), do_action(), attachment() |
current_user_can() | 60–63 | ->escape(), ->login(), current_user_can(), do_action(), absint(), attachment() |
current_user_can() | 66–69 | ->escape(), ->login(), current_user_can(), do_action(), absint(), absint(), attachment() |
current_user_can() && isset($struct) | 72–75 | ->escape(), ->login(), current_user_can(), do_action(), absint(), absint(), absint(), attachment() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 91 | 17–72 | 9 | 3 fewer instructions than PHP 8.5 |
| 8.5 | 94 | 17–75 | 9 | |
| 8.4 | 94 | 17–75 | 9 | |
| 8.3 | 94 | 17–75 | 9 | |
| 8.2 | 94 | 17–75 | 9 | |
| 8.1 | 94 | 17–75 | 9 | |
| 7.4 | 94 | 17–75 | 9 |
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 · 1
One hook fires while wp_xmlrpc_server::wp_getMediaLibrary() runs, in this order:
- do_action( xmlrpc_call )actionline 4449 (+17 into the body)
Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
Uses · 9
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- do_action()Calls the callback functions that have been added to an action hook.
- absint()Converts a value to non-negative integer.
- get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.
- wp_xmlrpc_server::escape()Escapes string or array of strings for database.
- wp_xmlrpc_server::login()Logs user in.
- IXR_Error::__construct()PHP5 constructor.
- wp_xmlrpc_server::_prepare_media_item()Prepares media item data for return in an XML-RPC object.
Source code
public function wp_getMediaLibrary( $args ) { $this->escape( $args ); $username = $args[1]; $password = $args[2]; $struct = $args[3] ?? array(); $user = $this->login( $username, $password ); if ( ! $user ) { return $this->error; } if ( ! current_user_can( 'upload_files' ) ) { return new IXR_Error( 401, __( 'Sorry, you are not allowed to upload files.' ) ); } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getMediaLibrary', $args, $this ); $parent_id = ( isset( $struct['parent_id'] ) ) ? absint( $struct['parent_id'] ) : ''; $mime_type = $struct['mime_type'] ?? ''; $offset = ( isset( $struct['offset'] ) ) ? absint( $struct['offset'] ) : 0; $number = ( isset( $struct['number'] ) ) ? absint( $struct['number'] ) : -1; $attachments = get_posts( array( 'post_type' => 'attachment', 'post_parent' => $parent_id, 'offset' => $offset, 'numberposts' => $number, 'post_mime_type' => $mime_type, ) ); $attachments_struct = array(); foreach ( $attachments as $attachment ) { $attachments_struct[] = $this->_prepare_media_item( $attachment ); } return $attachments_struct; }Changelog
Introduced in 3.1.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 7.0.4 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.