Changeset 52180 for trunk/src/wp-includes/link-template.php

Timestamp:

11/16/2021 02:55:04 PM (3 years ago)

Author:

hellofromTonya

Message:

Taxonomy: Allow get_*_*_link() and edit_term_link() functions to accept a term ID, WP_Term, or term object.

get_term() accepts a term ID, instance of WP_Term, or an object (i.e. stdClass as a result of a db query). Functions that use get_term() also now allow for the same data types.

Why? For consistency, removing extra processing code in consuming functions, and performance.

Functions changed in this commit are:

• get_category_feed_link()
• get_term_feed_link()
• get_tag_feed_link()
• get_edit_tag_link()
• get_edit_term_link()
• edit_term_link()

For each of consumer of these functions, changes to pass the object instead of the term ID.

Includes unit/integration tests for test coverage of these changes.

Follow-up to [6365], [9136], [9340], [14711], [15792], [15800], [18827], [32606], [36646], [37252].

Props davidbinda, johnbillion, peterwilsoncc, hellofromTonya, sergeybiryukov, mista-flo, hareesh-pillai, audrasjb, jeffpaul, chaion07.
Fixes #50225.

File:

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

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

@@ -905 +905 @@
  * @since 2.5.0
  *
- * @param int    $cat_id Category ID.
- * @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
- *                       Default is the value of get_default_feed().
+ * @param int|WP_Term|object $cat  The ID or term 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.
  */
-function get_category_feed_link( $cat_id, $feed = '' ) {
-    return get_term_feed_link( $cat_id, 'category', $feed );
+function get_category_feed_link( $cat, $feed = '' ) {
+    return get_term_feed_link( $cat, 'category', $feed );
 }
 
@@ -922 +922 @@
  * @since 3.0.0
  *
- * @param int    $term_id  Term ID.
- * @param string $taxonomy Optional. Taxonomy of `$term_id`. Default 'category'.
- * @param string $feed     Optional. Feed type. Possible values include 'rss2', 'atom'.
- *                         Default is the value of get_default_feed().
+ * @param int|WP_Term|object $term     The ID or term object whose feed link will be retrieved.
+ * @param string             $taxonomy Optional. Taxonomy of `$term_id`.
+ *                                     Defaults to 'category' if term ID or non WP_Term object is passed.
+ * @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.
  */
-function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
-    $term_id = (int) $term_id;
-
-    $term = get_term( $term_id, $taxonomy );
+function get_term_feed_link( $term, $taxonomy = '', $feed = '' ) {
+    if ( ! is_object( $term ) ) {
+        $term     = (int) $term;
+        $taxonomy = 'category';
+    } elseif ( ! $term instanceof WP_Term ) {
+        $taxonomy = $term->taxonomy;
+    }
+
+    $term = get_term( $term, $taxonomy );
 
     if ( empty( $term ) || is_wp_error( $term ) ) {
@@ -945 +951 @@
     if ( ! $permalink_structure ) {
         if ( 'category' === $taxonomy ) {
-            $link = home_url( "?feed=$feed&cat=$term_id" );
+            $link = home_url( "?feed=$feed&cat=$term->term_id" );
         } elseif ( 'post_tag' === $taxonomy ) {
             $link = home_url( "?feed=$feed&tag=$term->slug" );
@@ -953 +959 @@
         }
     } else {
-        $link = get_term_link( $term_id, $term->taxonomy );
+        $link = get_term_link( $term, $term->taxonomy );
         if ( get_default_feed() == $feed ) {
             $feed_link = 'feed';
@@ -1004 +1010 @@
  * @since 2.3.0
  *
- * @param int    $tag_id Tag ID.
- * @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
- *                       Default is the value of get_default_feed().
- * @return string The feed permalink for the given tag.
- */
-function get_tag_feed_link( $tag_id, $feed = '' ) {
-    return get_term_feed_link( $tag_id, 'post_tag', $feed );
+ * @param int|WP_Term|object $tag  The ID or term 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                  The feed permalink for the given tag.
+ */
+function get_tag_feed_link( $tag, $feed = '' ) {
+    return get_term_feed_link( $tag, 'post_tag', $feed );
 }
 
@@ -1018 +1024 @@
  * @since 2.7.0
  *
- * @param int    $tag_id   Tag ID.
- * @param string $taxonomy Optional. Taxonomy slug. Default 'post_tag'.
+ * @param int|WP_Term|object $tag      The ID or term object whose edit link will be retrieved.
+ * @param string             $taxonomy Optional. Taxonomy slug. Default 'post_tag'.
  * @return string The edit tag link URL for the given tag.
  */
-function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
+function get_edit_tag_link( $tag, $taxonomy = 'post_tag' ) {
     /**
      * Filters the edit link for a tag (or term in another taxonomy).
@@ -1030 +1036 @@
      * @param string $link The term edit link.
      */
-    return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
+    return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag, $taxonomy ) );
 }
 
@@ -1063 +1069 @@
  * @since 4.5.0 The `$taxonomy` parameter was made optional.
  *
- * @param int    $term_id     Term ID.
- * @param string $taxonomy    Optional. Taxonomy. Defaults to the taxonomy of the term identified
- *                            by `$term_id`.
- * @param string $object_type Optional. The object type. Used to highlight the proper post type
- *                            menu on the linked page. Defaults to the first object_type associated
- *                            with the taxonomy.
+ * @param int|WP_Term|object $term        The ID or term object whose edit link will be retrieved.
+ * @param string             $taxonomy    Optional. Taxonomy. Defaults to the taxonomy of the term identified
+ *                                        by `$term`.
+ * @param string             $object_type Optional. The object type. Used to highlight the proper post type
+ *                                        menu on the linked page. Defaults to the first object_type associated
+ *                                        with the taxonomy.
  * @return string|null The edit term link URL for the given term, or null on failure.
  */
-function get_edit_term_link( $term_id, $taxonomy = '', $object_type = '' ) {
-    $term = get_term( $term_id, $taxonomy );
+function get_edit_term_link( $term, $taxonomy = '', $object_type = '' ) {
+    $term = get_term( $term, $taxonomy );
     if ( ! $term || is_wp_error( $term ) ) {
         return;
     }
 
-    $tax = get_taxonomy( $term->taxonomy );
-    if ( ! $tax || ! current_user_can( 'edit_term', $term->term_id ) ) {
+    $tax     = get_taxonomy( $term->taxonomy );
+    $term_id = $term->term_id;
+    if ( ! $tax || ! current_user_can( 'edit_term', $term_id ) ) {
         return;
     }
@@ -1084 +1091 @@
     $args = array(
         'taxonomy' => $taxonomy,
-        'tag_ID'   => $term->term_id,
+        'tag_ID'   => $term_id,
     );
 
@@ -1117 +1124 @@
  * @since 3.1.0
  *
- * @param string  $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
- * @param string  $before Optional. Display before edit link. Default empty.
- * @param string  $after  Optional. Display after edit link. Default empty.
- * @param WP_Term $term   Optional. Term object. If null, the queried object will be inspected. Default null.
- * @param bool    $echo   Optional. Whether or not to echo the return. Default true.
+ * @param string           $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
+ * @param string           $before Optional. Display before edit link. Default empty.
+ * @param string           $after  Optional. Display after edit link. Default empty.
+ * @param int|WP_Term|null $term   Optional. Term ID or object. If null, the queried object will be inspected. Default null.
+ * @param bool             $echo   Optional. Whether or not to echo the return. Default true.
  * @return string|void HTML content.
  */
@@ -1127 +1134 @@
     if ( is_null( $term ) ) {
         $term = get_queried_object();
+    } else {
+        $term = get_term( $term );
     }