Changeset 61670

Timestamp:

02/18/2026 04:38:42 AM (5 weeks ago)

Author:

westonruter

Message:

Customize: Ensure WP_Customize_Setting::update() and subclass overrides return consistent types.

This addresses PHPStan type check issues.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10952

Props westonruter, peterwilsoncc, justlevine.
See #64238, #61175.

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-setting.php (modified) (1 diff)
• customize/class-wp-customize-background-image-setting.php (modified) (1 diff)
• customize/class-wp-customize-filter-setting.php (modified) (1 diff)
• customize/class-wp-customize-header-image-setting.php (modified) (2 diffs)
• customize/class-wp-customize-nav-menu-item-setting.php (modified) (9 diffs)
• customize/class-wp-customize-nav-menu-setting.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -709 +709 @@
             do_action( "customize_update_{$this->type}", $value, $this );
 
-            return has_action( "customize_update_{$this->type}" );
+            return (bool) has_action( "customize_update_{$this->type}" );
         }
     }

trunk/src/wp-includes/customize/class-wp-customize-background-image-setting.php

@@ -27 +27 @@
     /**
      * @since 3.4.0
+     * @since 7.0.0 Return type updated from void to true for compatibility with base class.
      *
      * @param mixed $value The value to update. Not used.
+     * @return true Always returns true.
      */
     public function update( $value ) {
         remove_theme_mod( 'background_image_thumb' );
+        return true;
     }
 }

trunk/src/wp-includes/customize/class-wp-customize-filter-setting.php

@@ -23 +23 @@
      *
      * @since 3.4.0
+     * @since 7.0.0 Return type updated from void to true for compatibility with base class.
      *
      * @param mixed $value The value to update.
+     * @return true Always returns true.
      */
-    public function update( $value ) {}
+    public function update( $value ) {
+        return true;
+    }
 }

trunk/src/wp-includes/customize/class-wp-customize-header-image-setting.php

@@ -29 +29 @@
     /**
      * @since 3.4.0
+     * @since 7.0.0 Return type updated from void to true for compatibility with base class.
      *
      * @global Custom_Image_Header $custom_image_header
      *
      * @param mixed $value The value to update.
+     * @return true Always returns true.
      */
     public function update( $value ) {
@@ -59 +61 @@
             $custom_image_header->set_header_image( $value );
         }
+        return true;
     }
 }

trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

@@ -760 +760 @@
      *
      * @since 4.3.0
+     * @since 7.0.0 Return type updated from null|void to bool for compatibility with base class.
      *
      * @see wp_update_nav_menu_item()
@@ -766 +767 @@
      *                           entirely. See WP_Customize_Nav_Menu_Item_Setting::$default for what the value
      *                           should consist of.
-     * @return null|void
+     * @return bool Whether updated.
      */
     protected function update( $value ) {
         if ( $this->is_updated ) {
-            return;
+            return ( 'error' !== $this->update_status );
         }
 
@@ -807 +808 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'unexpected_nav_menu_setting' );
-                    return;
+                    return false;
                 }
 
@@ -813 +814 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'nav_menu_setting_failure' );
-                    return;
+                    return false;
                 }
 
@@ -819 +820 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'unexpected_previous_term_id' );
-                    return;
+                    return false;
                 }
 
@@ -833 +834 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'unexpected_nav_menu_item_setting' );
-                    return;
+                    return false;
                 }
 
@@ -839 +840 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'nav_menu_item_setting_failure' );
-                    return;
+                    return false;
                 }
 
@@ -845 +846 @@
                     $this->update_status = 'error';
                     $this->update_error  = new WP_Error( 'unexpected_previous_post_id' );
-                    return;
+                    return false;
                 }
 
@@ -887 +888 @@
             }
         }
+
+        return ( 'error' !== $this->update_status );
     }
 

trunk/src/wp-includes/customize/class-wp-customize-nav-menu-setting.php

@@ -467 +467 @@
      *
      * @since 4.3.0
+     * @since 7.0.0 Return type updated from null|void to bool for compatibility with base class.
      *
      * @see wp_update_nav_menu_object()
@@ -479 +480 @@
      *     @type bool   $auto_add    Whether pages will auto_add to this menu. Default false.
      * }
-     * @return null|void
+     * @return bool Whether updated.
      */
     protected function update( $value ) {
         if ( $this->is_updated ) {
-            return;
+            return ( 'error' !== $this->update_status );
         }
 
@@ -583 +584 @@
             }
         }
+
+        return ( 'error' !== $this->update_status );
     }