Changeset 30210

Timestamp:

11/03/2014 06:48:50 PM (10 years ago)

Author:

boonebgorges

Message:

Improve docblocks for get_the_taxonomies() and the_taxonomies().

• In the_taxonomies(), only document those arguments that are specific to the function. Arguments shared with get_the_taxonomies() should be documented in the later function's docblock.
• Add $args hash documentation to get_the_taxonomies().
• Remove the redundant default argument definition in the_taxonomies().

Fixes #27238.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -4135 +4135 @@
  *
  * @param array $args {
- *     Arguments about which post to use and how to format the output.
- *
- *     @type  int|WP_Post $post          Post ID or object to get taxonomies of. Default current post.
- *     @type  string      $before        Displays before the taxonomies. Default empty string.
- *     @type  string      $sep           Separates each taxonomy. Default is a space.
- *     @type  string      $after         Displays after the taxonomies. Default empty string.
- *     @type  string      $template      Template for displaying a taxonomy label and list of
- *                                       terms. Default is "Label: Terms."
- *     @type  string      $term_template Template for displaying a single term in the list.
- *                                       Default is the term name linked to its archive.
+ *     Arguments about which post to use and how to format the output. Shares all of the arguments supported by
+ *     {@link get_the_taxonomies()}, in addition to the following.
+ *
+ *     @type  int|WP_Post $post   Post ID or object to get taxonomies of. Default current post.
+ *     @type  string      $before Displays before the taxonomies. Default empty string.
+ *     @type  string      $sep    Separates each taxonomy. Default is a space.
+ *     @type  string      $after  Displays after the taxonomies. Default empty string.
  * }
+ * @param array $args See {@link get_the_taxonomies()} for a description of arguments and their defaults.
  */
 function the_taxonomies( $args = array() ) {
@@ -4153 +4151 @@
         'sep' => ' ',
         'after' => '',
-        /* translators: %s: taxonomy label, %l: list of terms formatted as per $term_template */
-        'template' => __( '%s: %l.' ),
-        /* translators: %1$s: term link, %2$s: term name */
-        'term_template' => '<a href="%1$s">%2$s</a>',
     );
 
@@ -4173 +4167 @@
  *
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @param array $args Override the defaults.
+ * @param array $args {
+ *     Arguments about how to format the list of taxonomies.
+ *
+ *     @type string $template      Template for displaying a taxonomy label and list of terms.
+ *                                 Default is "Label: Terms."
+ *     @type string $term_template Template for displaying a single term in the list. Default is the term name
+ *                                 linked to its archive.
+ * }
  * @return array List of taxonomies.
  */