Changeset 46660 for trunk/src/wp-includes/taxonomy.php

Timestamp:

11/05/2019 09:21:46 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -4378 +4378 @@
 
 /**
- * Retrieve all taxonomies of a post with just the names.
+ * Retrieve all taxonomy names for the given post.
  *
  * @since 2.5.0
  *
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return array An array of all taxonomy names for the given post.
+ * @return string[] An array of all taxonomy names for the given post.
  */
 function get_post_taxonomies( $post = 0 ) {
@@ -4493 +4493 @@
  * @param string $resource_type Optional. Type of resource $object_type is. Accepts 'post_type'
  *                              or 'taxonomy'. Default empty.
- * @return array An array of ancestors from lowest to highest in the hierarchy.
+ * @return int[] An array of IDs of ancestors from lowest to highest in the hierarchy.
  */
 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
@@ -4530 +4530 @@
      * @since 4.1.1 Introduced the `$resource_type` parameter.
      *
-     * @param array  $ancestors     An array of object ancestors.
+     * @param int[]  $ancestors     An array of IDs of object ancestors.
      * @param int    $object_id     Object ID.
      * @param string $object_type   Type of object.