<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[16046] trunk/wp-includes/class.wp-xmlrpc-server.php:
phpDoc and a bug fix for the new media XMLRPC functions.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/16046">16046</a></dd>
<dt>Author</dt> <dd>westi</dd>
<dt>Date</dt> <dd>2010-10-28 12:12:59 +0000 (Thu, 28 Oct 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>phpDoc and a bug fix for the new media XMLRPC functions. See <a href="http://trac.wordpress.org/ticket/15151">#15151</a> props koke.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesclasswpxmlrpcserverphp">trunk/wp-includes/class.wp-xmlrpc-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesclasswpxmlrpcserverphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class.wp-xmlrpc-server.php (16045 => 16046)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class.wp-xmlrpc-server.php 2010-10-28 12:02:52 UTC (rev 16045)
+++ trunk/wp-includes/class.wp-xmlrpc-server.php 2010-10-28 12:12:59 UTC (rev 16046)
</span><span class="lines">@@ -1484,13 +1484,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve media item.
</del><ins>+ * Retrieve a media item by ID
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><del>- * @todo Docment this!
</del><span class="cx"> *
</span><del>- * @param array $args Method parameters.
- * @return array
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - attachment_id
+ * @return array. Assocciative array containing:
+ * - 'date_created_gmt'
+ * - 'parent'
+ * - 'link'
+ * - 'thumbnail'
+ * - 'title'
+ * - 'caption'
+ * - 'description'
+ * - 'metadata'
</ins><span class="cx"> */
</span><span class="cx"> function wp_getMediaItem($args) {
</span><span class="cx"> $this->escape($args);
</span><span class="lines">@@ -1533,13 +1544,27 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve media library items.
- *
</del><ins>+ * Retrieves a collection of media library items (or attachments)
+ *
+ * Besides the common blog_id, username, and password arguments, it takes a filter
+ * array as 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 {@link 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')
+ *
</ins><span class="cx"> * @since 3.1.0
</span><del>- * @todo Document this.
</del><span class="cx"> *
</span><del>- * @param array $args Method parameters.
- * @return array
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - filter
+ * @return array. Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents
</ins><span class="cx"> */
</span><span class="cx"> function wp_getMediaLibrary($args) {
</span><span class="cx"> $raw_args = $args;
</span><span class="lines">@@ -1558,8 +1583,8 @@
</span><span class="cx">
</span><span class="cx"> do_action('xmlrpc_call', 'wp.getMediaLibrary');
</span><span class="cx">
</span><del>- $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : 0 ;
- $mime_type = ( isset($struct['mime_type']) ) ? absint($struct['mime_type']) : '' ;
</del><ins>+ $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : '' ;
+ $mime_type = ( isset($struct['mime_type']) ) ? $struct['mime_type'] : '' ;
</ins><span class="cx"> $offset = ( isset($struct['offset']) ) ? absint($struct['offset']) : 0 ;
</span><span class="cx"> $number = ( isset($struct['number']) ) ? absint($struct['number']) : -1 ;
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>