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.


git-svn-id: https://develop.svn.wordpress.org/trunk@29866 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-10-09 15:40:53 +00:00
parent adbed947d8
commit cfac76a2cc

View File

@ -3633,12 +3633,12 @@ function _update_generic_term_count( $terms, $taxonomy ) {
} }
/** /**
* Generates a permalink for a taxonomy term archive. * Generate a permalink for a taxonomy term archive.
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param object|int|string $term * @param object|int|string $term The term object, ID, or slug whose link will be retrieved.
* @param string $taxonomy (optional if $term is object) * @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. * @return string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist.
*/ */
function get_term_link( $term, $taxonomy = '') { function get_term_link( $term, $taxonomy = '') {