<!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" />
<title>[20636] trunk/wp-includes/class-wp-xmlrpc-server.php: Introduce minimum_args() method in XML-RPC and leverage it to return errors for insufficient arguments for methods that are new in 3.4.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { 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 #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#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>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20636">20636</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2012-04-28 21:25:25 +0000 (Sat, 28 Apr 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce minimum_args() method in XML-RPC and leverage it to return errors for insufficient arguments for methods that are new in 3.4.
props maxcutler, markoheijnen.
fixes <a href="http://core.trac.wordpress.org/ticket/20394">#20394</a>.</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 (20635 => 20636)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-xmlrpc-server.php 2012-04-28 21:22:07 UTC (rev 20635)
+++ trunk/wp-includes/class-wp-xmlrpc-server.php 2012-04-28 21:25:25 UTC (rev 20636)
</span><span class="lines">@@ -490,6 +490,24 @@
</span><span class="cx"> return $struct;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Checks if the method received at least the minimum number of arguments.
+ *
+ * @since 3.4
+ *
+ * @param string|array $args Sanitize single string or array of strings.
+ * @param int $count Minimum number of arguments.
+ * @return boolean if $args contains at least $count arguments.
+ */
+ protected function minimum_args( $args, $count ) {
+ if ( count( $args ) < $count ) {
+ $this->error = new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.' ) );
+ return false;
+ }
+
+ return true;
+ }
+
</ins><span class="cx"> /**
</span><span class="cx"> * Prepares taxonomy data for return in an XML-RPC object.
</span><span class="cx"> *
</span><span class="lines">@@ -766,6 +784,9 @@
</span><span class="cx"> * @return string post_id
</span><span class="cx"> */
</span><span class="cx"> function wp_newPost( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1038,6 +1059,9 @@
</span><span class="cx"> * @return true on success
</span><span class="cx"> */
</span><span class="cx"> function wp_editPost( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 5 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1090,6 +1114,9 @@
</span><span class="cx"> * @return true on success
</span><span class="cx"> */
</span><span class="cx"> function wp_deletePost( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1163,6 +1190,9 @@
</span><span class="cx"> * - 'enclosure'
</span><span class="cx"> */
</span><span class="cx"> function wp_getPost( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1217,6 +1247,9 @@
</span><span class="cx"> * @return array contains a collection of posts.
</span><span class="cx"> */
</span><span class="cx"> function wp_getPosts( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1303,6 +1336,9 @@
</span><span class="cx"> * @return string term_id
</span><span class="cx"> */
</span><span class="cx"> function wp_newTerm( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1387,6 +1423,9 @@
</span><span class="cx"> * @return bool True, on success.
</span><span class="cx"> */
</span><span class="cx"> function wp_editTerm( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 5 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1476,6 +1515,9 @@
</span><span class="cx"> * @return boolean|IXR_Error If it suceeded true else a reason why not
</span><span class="cx"> */
</span><span class="cx"> function wp_deleteTerm( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 5 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1540,6 +1582,9 @@
</span><span class="cx"> * - 'count'
</span><span class="cx"> */
</span><span class="cx"> function wp_getTerm( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 5 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1590,6 +1635,9 @@
</span><span class="cx"> * @return array terms
</span><span class="cx"> */
</span><span class="cx"> function wp_getTerms( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1662,6 +1710,9 @@
</span><span class="cx"> * @return array (@see get_taxonomy())
</span><span class="cx"> */
</span><span class="cx"> function wp_getTaxonomy( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -1703,6 +1754,9 @@
</span><span class="cx"> * @return array taxonomies
</span><span class="cx"> */
</span><span class="cx"> function wp_getTaxonomies( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -3009,6 +3063,9 @@
</span><span class="cx"> * - 'supports'
</span><span class="cx"> */
</span><span class="cx"> function wp_getPostType( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span><span class="lines">@@ -3052,6 +3109,9 @@
</span><span class="cx"> * @return array
</span><span class="cx"> */
</span><span class="cx"> function wp_getPostTypes( $args ) {
</span><ins>+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
</ins><span class="cx"> $this->escape( $args );
</span><span class="cx">
</span><span class="cx"> $blog_id = (int) $args[0];
</span></span></pre>
</div>
</div>
</body>
</html>