Changeset 32837

Timestamp:

06/18/2015 01:19:12 PM (9 years ago)

Author:

boonebgorges

Message:

Add filters to wp_unique_term_slug().

This changeset adds two new filters:

• 'wp_unique_term_slug_is_bad_slug' lets developers control whether a test slug needs to be made unique, before the queries required to build a suffix are performed.
• 'wp_unique_term_slug' filters the output of the function.

These changes introduce parity with the filters in wp_unique_post_slug().

Props coffee2code, bolo1988, boonebgorges.
Fixes #20783.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (5 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -3325 +3325 @@
  *
  * @param string $slug The string that will be tried for a unique slug.
- * @param object $term The term object that the $slug will belong too.
+ * @param object $term The term object that the `$slug` will belong to.
  * @return string Will return a true unique slug.
  */
@@ -3331 +3331 @@
     global $wpdb;
 
-    if ( ! term_exists( $slug ) )
-        return $slug;
+    $needs_suffix = true;
+    $original_slug = $slug;
 
     // As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies.
-    if ( get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) {
-        return $slug;
+    if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) {
+        $needs_suffix = false;
     }
 
@@ -3343 +3343 @@
      * by incorporating parent slugs.
      */
-    if ( is_taxonomy_hierarchical($term->taxonomy) && !empty($term->parent) ) {
+    $parent_suffix = '';
+    if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) {
         $the_parent = $term->parent;
         while ( ! empty($the_parent) ) {
@@ -3349 +3350 @@
             if ( is_wp_error($parent_term) || empty($parent_term) )
                 break;
-            $slug .= '-' . $parent_term->slug;
-            if ( ! term_exists( $slug ) )
-                return $slug;
+            $parent_suffix .= '-' . $parent_term->slug;
+            if ( ! term_exists( $slug . $parent_suffix ) ) {
+                break;
+            }
 
             if ( empty($parent_term->parent) )
@@ -3360 +3362 @@
 
     // If we didn't get a unique slug, try appending a number to make it unique.
-    if ( ! empty( $term->term_id ) )
-        $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id );
-    else
-        $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
-
-    if ( $wpdb->get_var( $query ) ) {
-        $num = 2;
-        do {
-            $alt_slug = $slug . "-$num";
-            $num++;
-            $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
-        } while ( $slug_check );
-        $slug = $alt_slug;
-    }
-
-    return $slug;
+    /**
+     * Filter whether the proposed unique term slug is bad.
+     *
+     * @since 4.3.0
+     *
+     * @param bool   $needs_suffix Whether the slug needs to be made unique with a suffix.
+     * @param string $slug         The slug.
+     * @param object $term         Term object.
+     */
+    if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) {
+        if ( $parent_suffix ) {
+            $slug .= $parent_suffix;
+        } else {
+            if ( ! empty( $term->term_id ) )
+                $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id );
+            else
+                $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
+
+            if ( $wpdb->get_var( $query ) ) {
+                $num = 2;
+                do {
+                    $alt_slug = $slug . "-$num";
+                    $num++;
+                    $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
+                } while ( $slug_check );
+                $slug = $alt_slug;
+            }
+        }
+    }
+
+    /**
+     * Filter the unique term slug.
+     *
+     * @since 4.3.0
+     *
+     * @param string $slug          Unique term slug.
+     * @param object $term          Term object.
+     * @param string $original_slug Slug originally passed to the function for testing.
+     */
+    return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug );
 }