Changeset 56202

Timestamp:

07/11/2023 05:39:33 AM (15 months ago)

Author:

isabel_brison

Message:

Editor: opt out of Navigation fallback.

Allows developers to opt out of the auto-creation of the Navigation fallback through a filter.

Props get_dave, spacedmonkey, ramonopoly.
Fixes #58750.

Location:

trunk

Files:

• src/wp-includes/class-wp-navigation-fallback.php (modified) (1 diff)
• tests/phpunit/tests/editor/navigation-fallback.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-navigation-fallback.php

@@ -27 +27 @@
     public static function get_fallback() {
 
+        /**
+         * Filters whether or not a fallback should be created.
+         *
+         * @since 6.3.0
+         *
+         * @param bool Whether to create a fallback navigation menu. Default true.
+         */
+        $should_create_fallback = apply_filters( 'wp_navigation_should_create_fallback', true );
+
         $fallback = static::get_most_recently_published_navigation();
 
-        if ( $fallback ) {
+        if ( $fallback || ! $should_create_fallback ) {
             return $fallback;
         }

trunk/tests/phpunit/tests/editor/navigation-fallback.php

@@ -58 +58 @@
 
     /**
+     * @ticket 58750
+     *
+     * @covers WP_REST_Navigation_Fallback_Controller::get_fallback
+     */
+    public function test_should_not_automatically_create_fallback_if_filter_is_falsey() {
+
+        add_filter( 'wp_navigation_should_create_fallback', '__return_false' );
+
+        $data = WP_Navigation_Fallback::get_fallback();
+
+        $this->assertEmpty( $data );
+
+        $navs_in_db = $this->get_navigations_in_database();
+
+        $this->assertCount( 0, $navs_in_db, 'The fallback Navigation post should not have been created.' );
+
+        remove_filter( 'wp_navigation_should_create_fallback', '__return_false' );
+    }
+
+    /**
      * @ticket 58557
      * @covers WP_REST_Navigation_Fallback_Controller::get_fallback