Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-29 00:04:58 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Use a hash notation for the $args parameter to describe the fields argument in the DocBlock for wp_get_post_terms().

Browse Source 
Also, the `$taxonomy` parameter can accept either a string or array of taxonomies.

Props ohryan for the initial tip.
See #41017.

Built from https://develop.svn.wordpress.org/trunk@41034


git-svn-id: http://core.svn.wordpress.org/trunk@40884 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-07-12 22:21:41 +00:00
parent dfab72aa35
commit 597eeb9bb8
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
wp-includes/post.php
View File

@ -2838,21 +2838,21 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) {
} }
/** /**
* Retrieve the terms for a post. * Retrieves 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().
* *
* @since 2.8.0 * @since 2.8.0
* *
* @param int $post_id Optional. The Post ID. Does not default to the ID of the * @param int $post_id Optional. The Post ID. Does not default to the ID of the
* global $post. Default 0. * global $post. Default 0.
* @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'. * @param string|array $taxonomy Optional. The taxonomy slug or array of slugs for which
* @param array $args Optional. Term query parameters. Default empty array. * to retrieve terms. Default 'post_tag'.
* See WP_Term_Query::__construct() for supported arguments. * @param array $args {
* @return array|WP_Error Array of WP_Term objects on success or empty array if no terms were found. * Optional. Term query parameters. See WP_Term_Query::__construct() for supported arguments.
* WP_Error object if `$taxonomy` doesn't exist. *
* @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() ) { function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
$post_id = (int) $post_id; $post_id = (int) $post_id;

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-41033'; $wp_version = '4.9-alpha-41034';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.