<!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>[13482] trunk/wp-admin/includes/taxonomy.php: PHPDocs update.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13482">13482</a></dd>
<dt>Author</dt> <dd>dd32</dd>
<dt>Date</dt> <dd>2010-02-28 03:18:40 +0000 (Sun, 28 Feb 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>PHPDocs update. Props miqrogroove. See <a href="http://trac.wordpress.org/ticket/12422">#12422</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludestaxonomyphp">trunk/wp-admin/includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludestaxonomyphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/taxonomy.php (13481 => 13482)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/taxonomy.php 2010-02-28 03:08:16 UTC (rev 13481)
+++ trunk/wp-admin/includes/taxonomy.php 2010-02-28 03:18:40 UTC (rev 13482)
</span><span class="lines">@@ -80,12 +80,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * {@internal Missing Short Description}}
</del><ins>+ * Deletes one existing category.
</ins><span class="cx"> *
</span><del>- * @since unknown
</del><ins>+ * @since 2.0.0
</ins><span class="cx"> *
</span><del>- * @param unknown_type $cat_ID
- * @return unknown
</del><ins>+ * @param int $cat_ID
+ * @return mixed Returns true if completes delete action; false if term doesnt exist; Zero on attempted deletion of default Category; WP_Error object is also a possibility.
</ins><span class="cx"> */
</span><span class="cx"> function wp_delete_category($cat_ID) {
</span><span class="cx"> $cat_ID = (int) $cat_ID;
</span><span class="lines">@@ -99,13 +99,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * {@internal Missing Short Description}}
</del><ins>+ * Updates an existing Category or creates a new Category.
</ins><span class="cx"> *
</span><del>- * @since unknown
</del><ins>+ * @since 2.0.0
</ins><span class="cx"> *
</span><del>- * @param unknown_type $catarr
- * @param unknown_type $wp_error
- * @return unknown
</del><ins>+ * @param mixed $catarr See defaults below. Set 'cat_ID' to a non-zero value to update an existing category. The 'taxonomy' key was added in 3.0.0.
+ * @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
+ * @return int|object The ID number of the new or updated Category on success. Zero or a WP_Error on failure, depending on param $wp_error.
</ins><span class="cx"> */
</span><span class="cx"> function wp_insert_category($catarr, $wp_error = false) {
</span><span class="cx"> $cat_defaults = array('cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
</span><span class="lines">@@ -157,12 +157,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * {@internal Missing Short Description}}
</del><ins>+ * Aliases wp_insert_category() with minimal args.
</ins><span class="cx"> *
</span><del>- * @since unknown
</del><ins>+ * If you want to update only some fields of an existing category, call this
+ * function with only the new values set inside $catarr.
</ins><span class="cx"> *
</span><del>- * @param unknown_type $catarr
- * @return unknown
</del><ins>+ * @since 2.0.0
+ *
+ * @param array $catarr The 'cat_ID' value is required. All other keys are optional.
+ * @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
</ins><span class="cx"> */
</span><span class="cx"> function wp_update_category($catarr) {
</span><span class="cx"> $cat_ID = (int) $catarr['cat_ID'];
</span></span></pre>
</div>
</div>
</body>
</html>