WordPress.org

Make WordPress Core

Changeset 33931


Ignore:
Timestamp:
09/06/2015 12:11:56 AM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/post-functions.php

    r33922 r33931  
    36093609 * @since 2.3.0
    36103610 *
    3611  * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
    3612  *                        Default 0.
    3613  * @param string $tags    Optional. The tags to set for the post, separated by commas. Default empty.
    3614  * @return array|false|WP_Error Will return false if $post_id is not an integer or is 0.
     3611 * @param int          $post_id Optional. The Post ID. Does not default to the ID of the global $post.
     3612 * @param string|array $tags    Optional. An array of tags to set for the post, or a string of tags
     3613 *                             separated by commas. Default empty.
     3614 * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
    36153615 */
    36163616function wp_add_post_tags( $post_id = 0, $tags = '' ) {
     
    36253625 * @see wp_set_object_terms()
    36263626 *
    3627  * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
    3628  * @param string $tags    Optional. The tags to set for the post, separated by commas.
    3629  *                        Default empty.
    3630  * @param bool   $append  Optional. If true, don't delete existing tags, just add on. If false,
    3631  *                        replace the tags with the new tags. Default false.
     3627 * @param int          $post_id Optional. The Post ID. Does not default to the ID of the global $post.
     3628 * @param string|array $tags    Optional. An array of tags to set for the post, or a string of tags
     3629 *                              separated by commas. Default empty.
     3630 * @param bool         $append  Optional. If true, don't delete existing tags, just add on. If false,
     3631 *                              replace the tags with the new tags. Default false.
    36323632 * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
    36333633 */
     
    36433643 * @see wp_set_object_terms()
    36443644 *
    3645  * @param int    $post_id  Optional. The Post ID. Does not default to the ID of the global $post.
    3646  * @param string $tags     Optional. The tags to set for the post, separated by commas. Default empty.
    3647  * @param string $taxonomy Optional. Taxonomy name. Default 'post_tag'.
    3648  * @param bool   $append   Optional. If true, don't delete existing tags, just add on. If false,
    3649  *                         replace the tags with the new tags. Default false.
     3645 * @param int          $post_id  Optional. The Post ID. Does not default to the ID of the global $post.
     3646 * @param string|array $tags     Optional. An array of terms to set for the post, or a string of terms
     3647 *                               separated by commas. Default empty.
     3648 * @param string       $taxonomy Optional. Taxonomy name. Default 'post_tag'.
     3649 * @param bool         $append   Optional. If true, don't delete existing terms, just add on. If false,
     3650 *                               replace the terms with the new terms. Default false.
    36503651 * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
    36513652 */
Note: See TracChangeset for help on using the changeset viewer.