Changeset 33931

Timestamp:

09/06/2015 12:11:56 AM (10 years ago)

Author:

SergeyBiryukov

Message:

Update the parameter docs for wp_add_post_tags(), wp_set_post_tags(), and wp_set_post_terms().

Props johnbillion.
Fixes #33749.

File:

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

trunk/src/wp-includes/post-functions.php

@@ -3609 +3609 @@
  * @since 2.3.0
  *
- * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
- *                        Default 0.
- * @param string $tags    Optional. The tags to set for the post, separated by commas. Default empty.
- * @return array|false|WP_Error Will return false if $post_id is not an integer or is 0.
+ * @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 tags to set for the post, or a string of tags
+ *                              separated by commas. Default empty.
+ * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
  */
 function wp_add_post_tags( $post_id = 0, $tags = '' ) {
@@ -3625 +3625 @@
  * @see wp_set_object_terms()
  *
- * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
- * @param string $tags    Optional. The tags to set for the post, separated by commas.
- *                        Default empty.
- * @param bool   $append  Optional. If true, don't delete existing tags, just add on. If false,
- *                        replace the tags with the new tags. Default false.
+ * @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 tags to set for the post, or a string of tags
+ *                              separated by commas. Default empty.
+ * @param bool         $append  Optional. If true, don't delete existing tags, just add on. If false,
+ *                              replace the tags with the new tags. Default false.
  * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
  */
@@ -3643 +3643 @@
  * @see wp_set_object_terms()
  *
- * @param int    $post_id  Optional. The Post ID. Does not default to the ID of the global $post.
- * @param string $tags     Optional. The tags to set for the post, separated by commas. Default empty.
- * @param string $taxonomy Optional. Taxonomy name. Default 'post_tag'.
- * @param bool   $append   Optional. If true, don't delete existing tags, just add on. If false,
- *                         replace the tags with the new tags. Default false.
+ * @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
+ *                               separated by commas. Default empty.
+ * @param string       $taxonomy Optional. Taxonomy name. Default 'post_tag'.
+ * @param bool         $append   Optional. If true, don't delete existing terms, just add on. If false,
+ *                               replace the terms with the new terms. Default false.
  * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
  */