Changeset 32535 for trunk/src/wp-includes/class-wp-customize-widgets.php

Timestamp:

05/21/2015 10:04:29 PM (10 years ago)

Author:

wonderboymusic

Message:

In class-wp-customize-*, clarify/add some @param/@return blocks. Disambiguate some functions that are trying to return the void response of another function they call internally.

See #32444.

File:

• trunk/src/wp-includes/class-wp-customize-widgets.php (modified) (8 diffs)

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

@@ -123 +123 @@
             }
         }
-        return null;
     }
 
@@ -237 +236 @@
      *
      * @param array $old_sidebars_widgets
+     * @return array
      */
     public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {
@@ -254 +254 @@
      *
      * @param array $sidebars_widgets
+     * @return array
      */
     public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) {
@@ -919 +920 @@
      *
      * @param array $sidebars_widgets List of widgets for the current sidebar.
+     * @return array
      */
     public function preview_sidebars_widgets( $sidebars_widgets ) {
@@ -1041 +1043 @@
      * @param bool   $is_active  Whether the sidebar is active.
      * @param string $sidebar_id Sidebar ID.
+     * @return bool
      */
     public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
@@ -1066 +1069 @@
      * @param bool   $has_widgets Whether the current sidebar has widgets.
      * @param string $sidebar_id  Sidebar ID.
+     * @return bool
      */
     public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
@@ -1106 +1110 @@
      *
      * @param array $value Widget instance to sanitize.
-     * @return array Sanitized widget instance.
+     * @return array|null Sanitized widget instance.
      */
     public function sanitize_widget_instance( $value ) {
@@ -1117 +1121 @@
             || empty( $value['encoded_serialized_instance'] ) )
         {
-            return null;
+            return;
         }
 
         $decoded = base64_decode( $value['encoded_serialized_instance'], true );
         if ( false === $decoded ) {
-            return null;
+            return;
         }
 
         if ( $this->get_instance_hash_key( $decoded ) !== $value['instance_hash_key'] ) {
-            return null;
+            return;
         }
 
         $instance = unserialize( $decoded );
         if ( false === $instance ) {
-            return null;
+            return;
         }