<!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>[48622] trunk/src/wp-includes/category-template.php: Coding Standards: Rename the `$id` parameter in various category functions for clarity.</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/48622">48622</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/48622","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-26 16:05:39 +0000 (Sun, 26 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'>Coding Standards: Rename the `$id` parameter in various category functions for clarity.

See <a href="https://core.trac.wordpress.org/ticket/49542">#49542</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php       2020-07-26 14:06:03 UTC (rev 48621)

+++ trunk/src/wp-includes/category-template.php 2020-07-26 16:05:39 UTC (rev 48622)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,14 +37,14 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 1.2.0

<span class="cx" style="display: block; padding: 0 10px">  * @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int    $id         Category ID.

- * @param bool   $link       Optional. Whether to format with link. Default false.

- * @param string $separator  Optional. How to separate categories. Default '/'.

- * @param bool   $nicename   Optional. Whether to use nice name for display. Default false.

- * @param array  $deprecated Not used.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int    $category_id Category ID.

+ * @param bool   $link        Optional. Whether to format with link. Default false.

+ * @param string $separator   Optional. How to separate categories. Default '/'.

+ * @param bool   $nicename    Optional. Whether to use nice name for display. Default false.

+ * @param array  $deprecated  Not used.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return string|WP_Error A list of category parents on success, WP_Error on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_category_parents( $category_id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        if ( ! empty( $deprecated ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                _deprecated_argument( __FUNCTION__, '4.8.0' );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,7 +58,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">                'format'    => $format,

</span><span class="cx" style="display: block; padding: 0 10px">        );

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return get_term_parents_list( $id, 'category', $args );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return get_term_parents_list( $category_id, 'category', $args );

</ins><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px"> /**

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,11 +71,11 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 0.71

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $id Optional. The post ID. Defaults to current post ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id Optional. The post ID. Defaults to current post ID.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return WP_Term[] Array of WP_Term objects, one for each category assigned to the post.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_the_category( $id = false ) {

-       $categories = get_the_terms( $id, 'category' );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_the_category( $post_id = false ) {

+       $categories = get_the_terms( $post_id, 'category' );

</ins><span class="cx" style="display: block; padding: 0 10px">         if ( ! $categories || is_wp_error( $categories ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                $categories = array();

</span><span class="cx" style="display: block; padding: 0 10px">        }

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,12 +90,12 @@

<span class="cx" style="display: block; padding: 0 10px">         * Filters the array of categories to return for a post.

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.1.0

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @since 4.4.0 Added `$id` parameter.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @since 4.4.0 Added `$post_id` parameter.

</ins><span class="cx" style="display: block; padding: 0 10px">          *

<span class="cx" style="display: block; padding: 0 10px">         * @param WP_Term[] $categories An array of categories to return for the post.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param int|false $id         ID of the post.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param int|false $post_id    ID of the post.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return apply_filters( 'get_the_categories', $categories, $id );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'get_the_categories', $categories, $post_id );

</ins><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px"> /**

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,6 +132,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_the_category_list( $separator = '', $parents = '', $post_id = false ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $wp_rewrite;

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+

</ins><span class="cx" style="display: block; padding: 0 10px">         if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                /** This filter is documented in wp-includes/category-template.php */

</span><span class="cx" style="display: block; padding: 0 10px">                return apply_filters( 'the_category', '', $separator, $parents );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1140,10 +1141,11 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.3.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $id Post ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id Post ID.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return array|false|WP_Error Array of tag objects on success, false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_the_tags( $id = 0 ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_the_tags( $post_id = 0 ) {

+       $terms = get_the_terms( $post_id, 'post_tag' );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        /**

<span class="cx" style="display: block; padding: 0 10px">         * Filters the array of tags for the given post.

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1154,7 +1156,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

<span class="cx" style="display: block; padding: 0 10px">         * @param WP_Term[] $terms An array of tags for the given post.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'get_the_tags', $terms );

</ins><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px"> /**

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1162,13 +1164,14 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.3.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $before Optional. String to use before tags.

- * @param string $sep    Optional. String to use between the tags.

- * @param string $after  Optional. String to use after tags.

- * @param int    $id     Optional. Post ID. Defaults to the current post.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $before  Optional. String to use before tags.

+ * @param string $sep     Optional. String to use between the tags.

+ * @param string $after   Optional. String to use after tags.

+ * @param int    $post_id Optional. Post ID. Defaults to the current post.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0 ) {

+       $tag_list = get_the_term_list( $post_id, 'post_tag', $before, $sep, $after );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        /**

<span class="cx" style="display: block; padding: 0 10px">         * Filters the tags list for a given post.

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1179,9 +1182,9 @@

<span class="cx" style="display: block; padding: 0 10px">         * @param string $before   String to use before tags.

<span class="cx" style="display: block; padding: 0 10px">         * @param string $sep      String to use between the tags.

<span class="cx" style="display: block; padding: 0 10px">         * @param string $after    String to use after tags.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param int    $id       Post ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param int    $post_id  Post ID.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'the_tags', $tag_list, $before, $sep, $after, $post_id );

</ins><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px"> /**

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1286,7 +1289,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.5.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int    $id       Post ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int    $post_id  Post ID.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $taxonomy Taxonomy name.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $before   Optional. Before list.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $sep      Optional. Separate items using this.

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1293,8 +1296,8 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param string $after    Optional. After list.

<span class="cx" style="display: block; padding: 0 10px">  * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {

-       $terms = get_the_terms( $id, $taxonomy );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after = '' ) {

+       $terms = get_the_terms( $post_id, $taxonomy );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        if ( is_wp_error( $terms ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                return $terms;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1399,7 +1402,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.5.0

</span><span class="cx" style="display: block; padding: 0 10px">  *