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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@29626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-10-09 15:41:18 +00:00
parent 587599c54f
commit a724b435d8
1 changed files with 3 additions and 3 deletions

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 = '') {