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

Timestamp:

10/09/2014 03:40:53 PM (10 years ago)

Author:

DrewAPicture

Message:

Add more complete inline documentation for get_term_link().

Adds more complete parameter descriptions for the $term and $taxonomy parameters.

Props amruta123.b for the initial patch.
Fixes #29901.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy.php

@@ -3634 +3634 @@
 
 /**
- * Generates a permalink for a taxonomy term archive.
+ * Generate a permalink for a taxonomy term archive.
  *
  * @since 2.5.0
  *
- * @param object|int|string $term
- * @param string $taxonomy (optional if $term is object)
+ * @param object|int|string $term     The term object, ID, or slug whose link will be retrieved.
+ * @param string            $taxonomy Optional. Taxonomy. Default empty.
  * @return string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist.
  */