Changeset 48622

Timestamp:

07/26/2020 04:05:39 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename the $id parameter in various category functions for clarity.

See #49542.

File:

• trunk/src/wp-includes/category-template.php (modified) (13 diffs)

trunk/src/wp-includes/category-template.php

@@ -38 +38 @@
  * @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
  *
- * @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.
+ * @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.
  * @return string|WP_Error A list of category parents on success, WP_Error on failure.
  */
-function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
+function get_category_parents( $category_id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
 
     if ( ! empty( $deprecated ) ) {
@@ -59 +59 @@
     );
 
-    return get_term_parents_list( $id, 'category', $args );
+    return get_term_parents_list( $category_id, 'category', $args );
 }
 
@@ -72 +72 @@
  * @since 0.71
  *
- * @param int $id Optional. The post ID. Defaults to current post ID.
+ * @param int $post_id Optional. The post ID. Defaults to current post ID.
  * @return WP_Term[] Array of WP_Term objects, one for each category assigned to the post.
  */
-function get_the_category( $id = false ) {
-    $categories = get_the_terms( $id, 'category' );
+function get_the_category( $post_id = false ) {
+    $categories = get_the_terms( $post_id, 'category' );
     if ( ! $categories || is_wp_error( $categories ) ) {
         $categories = array();
@@ -91 +91 @@
      *
      * @since 3.1.0
-     * @since 4.4.0 Added `$id` parameter.
+     * @since 4.4.0 Added `$post_id` parameter.
      *
      * @param WP_Term[] $categories An array of categories to return for the post.
-     * @param int|false $id         ID of the post.
+     * @param int|false $post_id    ID of the post.
      */
-    return apply_filters( 'get_the_categories', $categories, $id );
+    return apply_filters( 'get_the_categories', $categories, $post_id );
 }
 
@@ -133 +133 @@
 function get_the_category_list( $separator = '', $parents = '', $post_id = false ) {
     global $wp_rewrite;
+
     if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) {
         /** This filter is documented in wp-includes/category-template.php */
@@ -1141 +1142 @@
  * @since 2.3.0
  *
- * @param int $id Post ID.
+ * @param int $post_id Post ID.
  * @return array|false|WP_Error Array of tag objects on success, false on failure.
  */
-function get_the_tags( $id = 0 ) {
+function get_the_tags( $post_id = 0 ) {
+    $terms = get_the_terms( $post_id, 'post_tag' );
 
     /**
@@ -1155 +1157 @@
      * @param WP_Term[] $terms An array of tags for the given post.
      */
-    return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );
+    return apply_filters( 'get_the_tags', $terms );
 }
 
@@ -1163 +1165 @@
  * @since 2.3.0
  *
- * @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.
+ * @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.
  * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
  */
-function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
+function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0 ) {
+    $tag_list = get_the_term_list( $post_id, 'post_tag', $before, $sep, $after );
 
     /**
@@ -1180 +1183 @@
      * @param string $sep      String to use between the tags.
      * @param string $after    String to use after tags.
-     * @param int    $id       Post ID.
+     * @param int    $post_id  Post ID.
      */
-    return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );
+    return apply_filters( 'the_tags', $tag_list, $before, $sep, $after, $post_id );
 }
 
@@ -1287 +1290 @@
  * @since 2.5.0
  *
- * @param int    $id       Post ID.
+ * @param int    $post_id  Post ID.
  * @param string $taxonomy Taxonomy name.
  * @param string $before   Optional. Before list.
@@ -1294 +1297 @@
  * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
  */
-function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
-    $terms = get_the_terms( $id, $taxonomy );
+function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after = '' ) {
+    $terms = get_the_terms( $post_id, $taxonomy );
 
     if ( is_wp_error( $terms ) ) {
@@ -1400 +1403 @@
  * @since 2.5.0
  *
- * @param int    $id       Post ID.
+ * @param int    $post_id  Post ID.
  * @param string $taxonomy Taxonomy name.
  * @param string $before   Optional. Before list.
@@ -1407 +1410 @@
  * @return void|false Void on success, false on failure.
  */
-function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
-    $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
+function the_terms( $post_id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
+    $term_list = get_the_term_list( $post_id, $taxonomy, $before, $sep, $after );
 
     if ( is_wp_error( $term_list ) ) {