Changeset 51070

Timestamp:

06/04/2021 10:46:22 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Simplify the logic in WP_Widget::get_field_name() and ::get_field_id().

Includes minor code layout fixes for better readability.

Follow-up to [41292], [50953], [50961].

Props 5ubliminal, solarissmoke, tamlyn, jdgrimes, jorbin, stevenkword, drebbits.web, westonruter, jipmoors, justinahinon, helen, lukecarbis, Mte90, hellofromTonya, SergeyBiryukov.
See #16773, #52627.

File:

• trunk/src/wp-includes/class-wp-widget.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp-widget.php

@@ -153 +153 @@
      *
      * @param string $id_base         Optional. Base ID for the widget, lowercase and unique. If left empty,
-     *                                a portion of the widget's class name will be used. Has to be unique.
+     *                                a portion of the widget's PHP class name will be used. Has to be unique.
      * @param string $name            Name for the widget displayed on the configuration page.
      * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for
@@ -189 +189 @@
      *
      * @param string $id_base         Optional. Base ID for the widget, lowercase and unique. If left empty,
-     *                                a portion of the widget's class name will be used. Has to be unique.
+     *                                a portion of the widget's PHP class name will be used. Has to be unique.
      * @param string $name            Name for the widget displayed on the configuration page.
      * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for
@@ -210 +210 @@
      * @since 4.4.0 Array format field names are now accepted.
      *
-     * @param string $field_name Field name
-     * @return string Name attribute for $field_name
+     * @param string $field_name Field name.
+     * @return string Name attribute for `$field_name`.
      */
     public function get_field_name( $field_name ) {
         $pos = strpos( $field_name, '[' );
-        if ( false === $pos ) {
-            return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
+
+        if ( false !== $pos ) {
+            // Replace the first occurrence of '[' with ']['.
+            $field_name = '[' . substr_replace( $field_name, '][', $pos, strlen( '[' ) );
         } else {
-            return 'widget-' . $this->id_base . '[' . $this->number . '][' . substr_replace( $field_name, '][', $pos, strlen( '[' ) );
-        }
+            $field_name = '[' . $field_name . ']';
+        }
+
+        return 'widget-' . $this->id_base . '[' . $this->number . ']' . $field_name;
     }
 
@@ -235 +239 @@
      */
     public function get_field_id( $field_name ) {
-        return 'widget-' . $this->id_base . '-' . $this->number . '-' . trim( str_replace( array( '[]', '[', ']' ), array( '', '-', '' ), $field_name ), '-' );
+        $field_name = str_replace( array( '[]', '[', ']' ), array( '', '-', '' ), $field_name );
+        $field_name = trim( $field_name, '-' );
+
+        return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
     }
 
@@ -467 +474 @@
                  */
                 $instance = apply_filters( 'widget_update_callback', $instance, $new_instance, $old_instance, $this );
+
                 if ( false !== $instance ) {
                     $all_instances[ $number ] = $instance;
@@ -522 +530 @@
 
         $return = null;
+
         if ( false !== $instance ) {
             $return = $this->form( $instance );
@@ -543 +552 @@
             do_action_ref_array( 'in_widget_form', array( &$this, &$return, $instance ) );
         }
+
         return $return;
     }
@@ -555 +565 @@
      */
     public function _register_one( $number = -1 ) {
-        wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) );
-        _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) );
-        _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) );
+        wp_register_sidebar_widget(
+            $this->id,
+            $this->name,
+            $this->_get_display_callback(),
+            $this->widget_options,
+            array( 'number' => $number )
+        );
+
+        _register_widget_update_callback(
+            $this->id_base,
+            $this->_get_update_callback(),
+            $this->control_options,
+            array( 'number' => -1 )
+        );
+
+        _register_widget_form_callback(
+            $this->id,
+            $this->name,
+            $this->_get_form_callback(),
+            $this->control_options,
+            array( 'number' => $number )
+        );
     }
 
@@ -602 +631 @@
 
         unset( $settings['_multiwidget'], $settings['__i__'] );
+
         return $settings;
     }