Changeset 53825 for trunk/src/wp-includes/post.php

Timestamp:

08/04/2022 02:07:28 PM (2 years ago)

Author:

desrosj

Message:

Posts, Post Types: Change variable name in wp_set_post_terms() for clarity.

This changes the $tags variable used within wp_set_post_terms() to $terms.

While the default for the $taxonomy argument is post_tag, the function can be used to assign terms to a post for any taxonomy. When a different taxonomy is passed, $tags is an inaccurate name and could be confusing.

Props hilayt24, costdev, SergeyBiryukov, krishaweb, desrosj.
Fixes #56331.

File:

• trunk/src/wp-includes/post.php (modified) (4 diffs)

trunk/src/wp-includes/post.php

@@ -5210 +5210 @@
  *
  * @param int          $post_id  Optional. The Post ID. Does not default to the ID of the global $post.
- * @param string|array $tags     Optional. An array of terms to set for the post, or a string of terms
+ * @param string|array $terms    Optional. An array of terms to set for the post, or a string of terms
  *                               separated by commas. Hierarchical taxonomies must always pass IDs rather
  *                               than names so that children with the same names but different parents
@@ -5219 +5219 @@
  * @return array|false|WP_Error Array of term taxonomy IDs of affected terms. WP_Error or false on failure.
  */
-function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
+function wp_set_post_terms( $post_id = 0, $terms = '', $taxonomy = 'post_tag', $append = false ) {
     $post_id = (int) $post_id;
 
@@ -5226 +5226 @@
     }
 
-    if ( empty( $tags ) ) {
-        $tags = array();
-    }
-
-    if ( ! is_array( $tags ) ) {
+    if ( empty( $terms ) ) {
+        $terms = array();
+    }
+
+    if ( ! is_array( $terms ) ) {
         $comma = _x( ',', 'tag delimiter' );
         if ( ',' !== $comma ) {
-            $tags = str_replace( $comma, ',', $tags );
-        }
-        $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
+            $terms = str_replace( $comma, ',', $terms );
+        }
+        $terms = explode( ',', trim( $terms, " \n\t\r\0\x0B," ) );
     }
 
@@ -5243 +5243 @@
      */
     if ( is_taxonomy_hierarchical( $taxonomy ) ) {
-        $tags = array_unique( array_map( 'intval', $tags ) );
-    }
-
-    return wp_set_object_terms( $post_id, $tags, $taxonomy, $append );
+        $terms = array_unique( array_map( 'intval', $terms ) );
+    }
+
+    return wp_set_object_terms( $post_id, $terms, $taxonomy, $append );
 }