Changeset 53158 for trunk/src/wp-includes/widgets/class-wp-widget-media.php

Timestamp:

04/12/2022 03:38:42 PM (4 years ago)

Author:

audrasjb

Message:

Widgets: Avoid 27 duplicate translations in Media Widgets constructor.

This changeset rationalizes the declaration of translation strings in the Media Widgets constructor.

Props Chouby, audrasjb, peterwilsoncc, costdev.
Fixes #54561.

File:

• trunk/src/wp-includes/widgets/class-wp-widget-media.php (modified) (5 diffs)

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

@@ -43 +43 @@
 
         /**
+         * The default widget description.
+         *
+         * @since 6.0.0
+         * @var string
+         */
+        protected static $default_description = '';
+
+        /**
+         * The default localized strings used by the widget.
+         *
+         * @since 6.0.0
+         * @var string[]
+         */
+        protected static $l10n_defaults = array();
+
+        /**
          * Constructor.
          *
@@ -58 +74 @@
                         $widget_options,
                         array(
-                                'description'                 => __( 'A media item.' ),
+                                'description'                 => self::get_default_description(),
                                 'customize_selective_refresh' => true,
                                 'show_instance_in_rest'       => true,
@@ -67 +83 @@
                 $control_opts = wp_parse_args( $control_options, array() );
 
-                $l10n_defaults = array(
-                        'no_media_selected'          => __( 'No media selected' ),
-                        'add_media'                  => _x( 'Add Media', 'label for button in the media widget' ),
-                        'replace_media'              => _x( 'Replace Media', 'label for button in the media widget; should preferably not be longer than ~13 characters long' ),
-                        'edit_media'                 => _x( 'Edit Media', 'label for button in the media widget; should preferably not be longer than ~13 characters long' ),
-                        'add_to_widget'              => __( 'Add to Widget' ),
-                        'missing_attachment'         => sprintf(
-                                /* translators: %s: URL to media library. */
-                                __( 'That file cannot be found. Check your <a href="%s">media library</a> and make sure it was not deleted.' ),
-                                esc_url( admin_url( 'upload.php' ) )
-                        ),
-                        /* translators: %d: Widget count. */
-                        'media_library_state_multi'  => _n_noop( 'Media Widget (%d)', 'Media Widget (%d)' ),
-                        'media_library_state_single' => __( 'Media Widget' ),
-                        'unsupported_file_type'      => __( 'Looks like this is not the correct kind of file. Please link to an appropriate file instead.' ),
-                );
-                $this->l10n    = array_merge( $l10n_defaults, array_filter( $this->l10n ) );
+                $this->l10n = array_merge( self::get_l10n_defaults(), array_filter( $this->l10n ) );
 
                 parent::__construct(
@@ -442 +442 @@
 
         /**
+         * Resets the cache for the default labels.
+         *
+         * @since 6.0.0
+         */
+        public static function reset_default_labels() {
+                self::$default_description = '';
+                self::$l10n_defaults       = array();
+        }
+
+        /**
          * Whether the widget has content to show.
          *
@@ -452 +462 @@
                 return ( $instance['attachment_id'] && 'attachment' === get_post_type( $instance['attachment_id'] ) ) || $instance['url'];
         }
+
+        /**
+         * Returns the default description of the widget.
+         *
+         * @since 6.0.0
+         *
+         * @var string
+         */
+        protected static function get_default_description() {
+                if ( self::$default_description ) {
+                        return self::$default_description;
+                }
+
+                self::$default_description = __( 'A media item.' );
+                return self::$default_description;
+        }
+
+        /**
+         * Returns the default localized strings used by the widget.
+         *
+         * @since 6.0.0
+         *
+         * @return string[]
+         */
+        protected static function get_l10n_defaults() {
+                if ( ! empty( self::$l10n_defaults ) ) {
+                        return self::$l10n_defaults;
+                }
+
+                self::$l10n_defaults = array(
+                        'no_media_selected'          => __( 'No media selected' ),
+                        'add_media'                  => _x( 'Add Media', 'label for button in the media widget' ),
+                        'replace_media'              => _x( 'Replace Media', 'label for button in the media widget; should preferably not be longer than ~13 characters long' ),
+                        'edit_media'                 => _x( 'Edit Media', 'label for button in the media widget; should preferably not be longer than ~13 characters long' ),
+                        'add_to_widget'              => __( 'Add to Widget' ),
+                        'missing_attachment'         => sprintf(
+                                /* translators: %s: URL to media library. */
+                                __( 'That file cannot be found. Check your <a href="%s">media library</a> and make sure it was not deleted.' ),
+                                esc_url( admin_url( 'upload.php' ) )
+                        ),
+                        /* translators: %d: Widget count. */
+                        'media_library_state_multi'  => _n_noop( 'Media Widget (%d)', 'Media Widget (%d)' ),
+                        'media_library_state_single' => __( 'Media Widget' ),
+                        'unsupported_file_type'      => __( 'Looks like this is not the correct kind of file. Please link to an appropriate file instead.' ),
+                );
+
+                return self::$l10n_defaults;
+        }
 }