Changeset 52959

Timestamp:

03/20/2022 03:03:39 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct variable references in get_category_feed_link() and get_term_feed_link() @return tags.

The $cat_id and $term_id variables were replaced by $cat and $term, respectively.

Follow-up to [52180].

See #54729.

File:

• trunk/src/wp-includes/link-template.php (modified) (2 diffs)

trunk/src/wp-includes/link-template.php

@@ -905 +905 @@
  * @since 2.5.0
  *
- * @param int|WP_Term|object $cat  The ID or term object whose feed link will be retrieved.
+ * @param int|WP_Term|object $cat  The ID or category object whose feed link will be retrieved.
  * @param string             $feed Optional. Feed type. Possible values include 'rss2', 'atom'.
  *                                 Default is the value of get_default_feed().
- * @return string Link to the feed for the category specified by $cat_id.
+ * @return string Link to the feed for the category specified by `$cat`.
  */
 function get_category_feed_link( $cat, $feed = '' ) {
@@ -926 +926 @@
  * @param string             $feed     Optional. Feed type. Possible values include 'rss2', 'atom'.
  *                                     Default is the value of get_default_feed().
- * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
+ * @return string|false Link to the feed for the term specified by `$term` and `$taxonomy`.
  */
 function get_term_feed_link( $term, $taxonomy = '', $feed = '' ) {