<!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>[48599] trunk/src/wp-includes/taxonomy.php: Docs: Correct some documentation for `wp_update_term()`.</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 { white-space: pre-line; 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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48599">48599</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48599","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-24 12:02:47 +0000 (Fri, 24 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Correct some documentation for `wp_update_term()`.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2020-07-24 01:19:03 UTC (rev 48598)
+++ trunk/src/wp-includes/taxonomy.php 2020-07-24 12:02:47 UTC (rev 48599)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2138,7 +2138,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 3. The 'term_id_filter' is evaluated.
</span><span class="cx" style="display: block; padding: 0 10px"> * 4. The term cache is cleaned.
</span><span class="cx" style="display: block; padding: 0 10px"> * 5. Several more actions are fired.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 6. An array is returned containing the term_id and term_taxonomy_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 6. An array is returned containing the `term_id` and `term_taxonomy_id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the 'slug' argument is not empty, then it is checked to see if the term
</span><span class="cx" style="display: block; padding: 0 10px"> * is invalid. If it is not a valid, existing term, it is added and the term_id
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2148,7 +2148,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the term is inserted and the term_id will be given.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Error handling:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If $taxonomy does not exist or $term is empty,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If `$taxonomy` does not exist or `$term` is empty,
</ins><span class="cx" style="display: block; padding: 0 10px"> * a WP_Error object will be returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the term already exists on the same hierarchical level,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2430,7 +2430,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $tt_id Taxonomy term ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $tt_id Term taxonomy ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2883,32 +2883,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Update term based on arguments provided.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The $args will indiscriminately override all values with the same field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The `$args` will indiscriminately override all values with the same field name.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Care must be taken to not override important information need to update or
</span><span class="cx" style="display: block; padding: 0 10px"> * update will fail (or perhaps create a new term, neither would be acceptable).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * defined in $args already.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * defined in `$args` already.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'alias_of' will create a term group, if it doesn't already exist, and update
- * it for the $term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'alias_of' will create a term group, if it doesn't already exist, and
+ * update it for the `$term`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the 'slug' argument in $args is missing, then the 'name' in $args will be
- * used. It should also be noted that if you set 'slug' and it isn't unique then
- * a WP_Error will be passed back. If you don't pass any slug, then a unique one
- * will be created for you.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If the 'slug' argument in `$args` is missing, then the 'name' will be used.
+ * If you set 'slug' and it isn't unique, then a WP_Error is returned.
+ * If you don't pass any slug, then a unique one will be created.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * For what can be overrode in `$args`, check the term scheme can contain and stay
- * away from the term keys.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $term_id The ID of the term
- * @param string $taxonomy The context in which to relate the term to the object.
- * @param array|string $args Optional. Array of get_terms() arguments. Default empty array.
- * @return array|WP_Error Returns Term ID and Taxonomy Term ID
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $term_id The ID of the term.
+ * @param string $taxonomy The taxonomy of the term.
+ * @param array|string $args {
+ * Optional. Array or string of arguments for updating a term.
+ *
+ * @type string $alias_of Slug of the term to make this term an alias of.
+ * Default empty string. Accepts a term slug.
+ * @type string $description The term description. Default empty string.
+ * @type int $parent The id of the parent term. Default 0.
+ * @type string $slug The term slug to use. Default empty string.
+ * }
+ * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
+ * WP_Error otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_update_term( $term_id, $taxonomy, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span></span></pre>
</div>
</div>
</body>
</html>