Changeset 39549

Timestamp:

12/09/2016 04:09:31 PM (8 years ago)

Author:

boonebgorges

Message:

Taxonomy: Introduce get_term_parents_list().

This new function is a taxonomy-agnostic version of get_category_parents().

Props keesiemeijer, SergeyBiryukov, rafaehlers.
Fixes #17069.

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (3 diffs)
• tests/phpunit/tests/category/getCategoryParents.php (modified) (1 diff)
• tests/phpunit/tests/term/getTermParentsList.php (added)

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

@@ -33 +33 @@
  *
  * @since 1.2.0
+ * @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
  *
  * @param int $id Category ID.
@@ -38 +39 @@
  * @param string $separator Optional, default is '/'. How to separate categories.
  * @param bool $nicename Optional, default is false. Whether to use nice name for display.
- * @param array $visited Optional. Already linked to categories to prevent duplicates.
+ * @param array $deprecated Not used.
  * @return string|WP_Error A list of category parents on success, WP_Error on failure.
  */
-function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) {
-    $chain = '';
-    $parent = get_term( $id, 'category' );
-    if ( is_wp_error( $parent ) )
-        return $parent;
-
-    if ( $nicename )
-        $name = $parent->slug;
-    else
-        $name = $parent->name;
-
-    if ( $parent->parent && ( $parent->parent != $parent->term_id ) && !in_array( $parent->parent, $visited ) ) {
-        $visited[] = $parent->parent;
-        $chain .= get_category_parents( $parent->parent, $link, $separator, $nicename, $visited );
-    }
-
-    if ( $link )
-        $chain .= '<a href="' . esc_url( get_category_link( $parent->term_id ) ) . '">'.$name.'</a>' . $separator;
-    else
-        $chain .= $name.$separator;
-    return $chain;
+function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
+
+    if ( ! empty( $deprecated ) ) {
+        _deprecated_argument( __FUNCTION__, '4.8.0' );
+    }
+
+    $format = $nicename ? 'slug' : 'name';
+
+    $args = array(
+        'separator' => $separator,
+        'link'      => $link,
+        'format'    => $format,
+    );
+
+    return get_term_parents_list( $id, 'category', $args );
 }
 
@@ -1234 +1229 @@
 
 /**
+ * Retrieve term parents with separator.
+ *
+ * @since 4.8.0
+ *
+ * @param int     $term_id  Term ID.
+ * @param string  $taxonomy Taxonomy name.
+ * @param string|array $args {
+ *     Array of optional arguments.
+ *
+ *     @type string $format    Use term names or slugs for display. Accepts 'name' or 'slug'.
+ *                             Default 'name'.
+ *     @type string $separator Separator for between the terms. Default '/'.
+ *     @type bool   $link      Whether to format as a link. Default true.
+ *     @type bool   $inclusive Include the term to get the parents for. Default true.
+ * }
+ * @return string|WP_Error A list of term parents on success, WP_Error or empty string on failure.
+ */
+function get_term_parents_list( $term_id, $taxonomy, $args = array() ) {
+    $list = '';
+    $term = get_term( $term_id, $taxonomy );
+
+    if ( is_wp_error( $term ) ) {
+        return $term;
+    }
+
+    if ( ! $term ) {
+        return $list;
+    }
+
+    $term_id = $term->term_id;
+
+    $defaults = array(
+        'format'    => 'name',
+        'separator' => '/',
+        'link'      => true,
+        'inclusive' => true,
+    );
+
+    $args = wp_parse_args( $args, $defaults );
+
+    foreach ( array( 'link', 'inclusive' ) as $bool ) {
+        $args[ $bool ] = wp_validate_boolean( $args[ $bool ] );
+    }
+
+    $parents = get_ancestors( $term_id, $taxonomy, 'taxonomy' );
+
+    if ( $args['inclusive'] ) {
+        array_unshift( $parents, $term_id );
+    }
+
+    foreach ( array_reverse( $parents ) as $term_id ) {
+        $parent = get_term( $term_id, $taxonomy );
+        $name   = ( 'slug' === $args['format'] ) ? $parent->slug : $parent->name;
+
+        if ( $args['link'] ) {
+            $list .= '<a href="' . esc_url( get_category_link( $parent->term_id ) ) . '">' . $name . '</a>' . $args['separator'];
+        } else {
+            $list .= $name . $args['separator'];
+        }
+    }
+
+    return $list;
+}
+
+/**
  * Display the terms in a list.
  *

trunk/tests/phpunit/tests/category/getCategoryParents.php

@@ -51 +51 @@
     }
 
-    public function test_visited_should_also_exclude_children_of_visited_categories() {
-        $c3 = self::factory()->category->create_and_get( array(
-            'parent' => $this->c2->term_id,
-        ) );
-        $c4 = self::factory()->category->create_and_get( array(
-            'parent' => $c3->term_id,
-        ) );
+    public function test_deprecated_argument_visited() {
+        $this->setExpectedDeprecated( 'get_category_parents' );
+        $found = get_category_parents( $this->c2->term_id, false, '/', false, array( $this->c1->term_id ) );
+    }
 
-        $expected = $this->c1->name . '/'. $this->c2->name . '/';
-        $found = get_category_parents( $this->c2->term_id, false, '/', false, array( $c3->term_id ) );
+    public function test_category_without_parents() {
+        $expected = $this->c1->name . '/';
+        $found = get_category_parents( $this->c1->term_id );
         $this->assertSame( $expected, $found );
     }