From f628aaacda3d7882ddd00bc047de540bd2821f73 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Wed, 12 Jul 2017 22:20:16 +0000 Subject: [PATCH] Docs: Use a hash notation for the `$args` parameter to describe the `fields` argument in the DocBlock for `wp_get_post_terms()`. Also, the `$taxonomy` parameter can accept either a string or array of taxonomies. Props ohryan for the initial tip. See #41017. git-svn-id: https://develop.svn.wordpress.org/trunk@41034 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post.php | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 3e00f19876..56c2ea5c75 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -2838,21 +2838,21 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { } /** - * Retrieve the terms for a post. - * - * There is only one default for this function, called 'fields' and by default - * is set to 'all'. There are other defaults that can be overridden in - * wp_get_object_terms(). + * Retrieves the terms for a post. * * @since 2.8.0 * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the - * global $post. Default 0. - * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'. - * @param array $args Optional. Term query parameters. Default empty array. - * See WP_Term_Query::__construct() for supported arguments. - * @return array|WP_Error Array of WP_Term objects on success or empty array if no terms were found. - * WP_Error object if `$taxonomy` doesn't exist. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the + * global $post. Default 0. + * @param string|array $taxonomy Optional. The taxonomy slug or array of slugs for which + * to retrieve terms. Default 'post_tag'. + * @param array $args { + * Optional. Term query parameters. See WP_Term_Query::__construct() for supported arguments. + * + * @type string $fields Term fields to retrieve. Default 'all'. + * } + * @return array|WP_Error Array of WP_Term objects on success or empty array if no terms were found. + * WP_Error object if `$taxonomy` doesn't exist. */ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) { $post_id = (int) $post_id;