Ticket #21112: 21112.5.diff

src/wp-includes/post.php

@@ -4053 +4053 @@
                 return $slug;
         }
 
+        /**
+         * Filters the post slug before it is generated to be unique.
+         *
+         * Returning a non-null value will short-circuit the
+         * unique slug generation, returning the passed value instead.
+         *
+         * @since 5.1.0
+         *
+         * @param string $override_slug Short-circuit return value.
+         * @param string $slug          The desired slug (post_name).
+         * @param int    $post_ID       Post ID.
+         * @param string $post_status   The post status.
+         * @param string $post_type     Post type.
+         * @param int    $post_parent   Post parent ID.
+         */
+        $override_slug = apply_filters( 'pre_wp_unique_post_slug', null, $slug, $post_ID, $post_status, $post_type, $post_parent );
+        if ( null !== $override_slug ) {
+                return $override_slug;
+        }
+
         global $wpdb, $wp_rewrite;
 
         $original_slug = $slug;

tests/phpunit/tests/post.php

@@ -1357 +1357 @@
                 $this->assertEquals( $changeset_data, json_decode( get_post( $post_id )->post_content, true ) );
         }
 
+        /**
+         * Test ensuring that the post_slug can be filtered with a custom value short circuiting the built in
+         * function that tries to create a unique name based on the post name.
+         *
+         * @see wp_unique_post_slug()
+         * @ticket 21112
+         */
+        function test_pre_wp_unique_post_slug_filter() {
+                add_filter( 'pre_wp_unique_post_slug', array( $this, 'filter_pre_wp_unique_post_slug' ), 10, 6 );
+
+                $post_id = $this->factory->post->create( array( 'title' => 'An example', 'post_status' => 'publish', 'post_type' => 'page' ) );
+                $post = get_post( $post_id );
+                $this->assertEquals( 'override-slug-' . $post->post_type, $post->post_name );
+
+                remove_filter( 'pre_wp_unique_post_slug', array( $this, 'filter_pre_wp_unique_post_slug' ), 10, 6 );
+        }
+
+        function filter_pre_wp_unique_post_slug( $default, $slug, $post_ID, $post_status, $post_type, $post_parent ) {
+                return 'override-slug-' . $post_type;
+        }
 }