The get_term_link returns a URL but it's @return and name lead you to believe it's returning an HTML link

[garrett-eclipse]

Hello,

I went to use the get_term_link function after reading the ​documentation and was confused by it returning a URL and not an HTML link as it was indicated. The function name also leads you to believe it'll be a link returned and not a URL.

<?php
/**
 * Generate a permalink for a taxonomy term archive.
 *
 * @since 2.5.0
 *
 * @global WP_Rewrite $wp_rewrite
 *
 * @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.
 */
function get_term_link( $term, $taxonomy = '' ) {

I doubt renaming the function is viable due to back-compat but it would be nice at least to correct the php docblock to indicate the return is a URL and not an HTML Link.

Thanks

[garrett-eclipse]

Updated phpdocblock to replace HTML Link verbiage with URL

[garrett-eclipse]

Added minor patch to tweak the verbiage and indicate it's a URL and not an HTML Link

[SergeyBiryukov]

In 45702:

Docs: Correct @return value description for get_term_link().

Props garrett-eclipse.
Fixes #47806.