Changeset 49241

Timestamp:

10/20/2020 05:37:16 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Upgrade/Install: Introduce a wrapper for the auto_update_{$type} filter checks.

This allows for cleaner checks whether auto-updates are forced for a plugin or theme.

Follow-up to [48750].

Props rebasaurus, garrett-eclipse, SergeyBiryukov.
Fixes #50875.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-debug-data.php (modified) (5 diffs)
• class-wp-ms-themes-list-table.php (modified) (1 diff)
• class-wp-plugins-list-table.php (modified) (1 diff)
• class-wp-site-health.php (modified) (1 diff)
• theme.php (modified) (1 diff)
• update.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -978 +978 @@
                 }
 
-                $type = 'plugin';
-                /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
+                $auto_update_forced = wp_is_auto_update_forced_for_item( 'plugin', null, (object) $item );
 
                 if ( ! is_null( $auto_update_forced ) ) {
@@ -1122 +1120 @@
             }
 
-            $type = 'theme';
-            /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-            $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
+            $auto_update_forced = wp_is_auto_update_forced_for_item( 'theme', null, (object) $item );
 
             if ( ! is_null( $auto_update_forced ) ) {
@@ -1210 +1206 @@
                 }
 
-                $type = 'theme';
-                /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
+                $auto_update_forced = wp_is_auto_update_forced_for_item( 'theme', null, (object) $item );
 
                 if ( ! is_null( $auto_update_forced ) ) {
@@ -1300 +1294 @@
                 }
 
-                $type = 'theme';
-                /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
+                $auto_update_forced = wp_is_auto_update_forced_for_item( 'theme', null, (object) $item );
 
                 if ( ! is_null( $auto_update_forced ) ) {
@@ -1328 +1320 @@
 
                 $theme_version_string       .= ' | ' . $auto_updates_string;
-                $theme_version_string_debug .= ',' . $auto_updates_string;
+                $theme_version_string_debug .= ', ' . $auto_updates_string;
             }
 

trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

@@ -182 +182 @@
             $filter_payload = array_merge( $filter_payload, array_intersect_key( $theme_data, $filter_payload ) );
 
-            $type = 'theme';
-            /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-            $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $filter_payload );
+            $auto_update_forced = wp_is_auto_update_forced_for_item( 'theme', null, $filter_payload );
 
             if ( ! is_null( $auto_update_forced ) ) {

trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

@@ -230 +230 @@
                 'compatibility' => new stdClass(),
             );
+
             $filter_payload = (object) array_merge( $filter_payload, array_intersect_key( $plugin_data, $filter_payload ) );
 
-            $type = 'plugin';
-            /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-            $auto_update_forced = apply_filters( "auto_update_{$type}", null, $filter_payload );
+            $auto_update_forced = wp_is_auto_update_forced_for_item( 'plugin', null, $filter_payload );
 
             if ( ! is_null( $auto_update_forced ) ) {

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2399 +2399 @@
         );
 
-        $type = 'plugin';
-        /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-        $test_plugins_enabled = apply_filters( "auto_update_{$type}", true, $mock_plugin );
-
-        $type = 'theme';
-        /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-        $test_themes_enabled = apply_filters( "auto_update_{$type}", true, $mock_theme );
+        $test_plugins_enabled = wp_is_auto_update_forced_for_item( 'plugin', true, $mock_plugin );
+        $test_themes_enabled  = wp_is_auto_update_forced_for_item( 'theme', true, $mock_theme );
 
         $ui_enabled_for_plugins = wp_is_auto_update_enabled_for_type( 'plugin' );

trunk/src/wp-admin/includes/theme.php

@@ -717 +717 @@
         }
 
-        $type = 'theme';
-        /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-        $auto_update_forced = apply_filters( "auto_update_{$type}", null, $auto_update_filter_payload );
+        $auto_update_forced = wp_is_auto_update_forced_for_item( 'theme', null, $auto_update_filter_payload );
 
         $prepared_themes[ $slug ] = array(

trunk/src/wp-admin/includes/update.php

@@ -1047 +1047 @@
 
 /**
+ * Checks whether auto-updates are forced for an item.
+ *
+ * @since 5.6.0
+ *
+ * @param string    $type   The type of update being checked: 'theme' or 'plugin'.
+ * @param bool|null $update Whether to update. The value of null is internally used
+ *                          to detect whether nothing has hooked into this filter.
+ * @param object    $item   The update offer.
+ * @return bool True if auto-updates are forced for `$item`, false otherwise.
+ */
+function wp_is_auto_update_forced_for_item( $type, $update, $item ) {
+    /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+    return apply_filters( "auto_update_{$type}", $update, $item );
+}
+
+/**
  * Determines the appropriate auto-update message to be displayed.
  *