Changeset 48756

Timestamp:

08/07/2020 07:23:04 PM (5 years ago)

Author:

whyisjake

Message:

Docs: Correct usage of the dynamic auto_update_{$type} filter.

This ensures that the canonical name of the filter is used in Site Health debug data, as well as on plugin and theme screens, so the developer reference site remains correct.

This brings the changes from [48750] to the 5.5 branch.

Props johnbillion.
Fixes #50868, see [48750].

Location:

branches/5.5

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/class-wp-automatic-updater.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-debug-data.php (modified) (4 diffs)
• src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-site-health.php (modified) (1 diff)
• src/wp-admin/includes/theme.php (modified) (1 diff)

branches/5.5/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -180 +180 @@
          *
          * The dynamic portion of the hook name, `$type`, refers to the type of update
-         * being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
+         * being checked. Potential hook names include:
+         *
+         *  - `auto_update_core`
+         *  - `auto_update_plugin`
+         *  - `auto_update_theme`
+         *  - `auto_update_translation`
          *
          * Generally speaking, plugins, themes, and major core versions are not updated

branches/5.5/src/wp-admin/includes/class-wp-debug-data.php

@@ -972 +972 @@
                 }
 
-                /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( 'auto_update_plugin', null, (object) $item );
+                $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 );
 
                 if ( ! is_null( $auto_update_forced ) ) {
@@ -1115 +1116 @@
             }
 
-            /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-            $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
+            $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 );
 
             if ( ! is_null( $auto_update_forced ) ) {
@@ -1202 +1204 @@
                 }
 
-                /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
+                $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 );
 
                 if ( ! is_null( $auto_update_forced ) ) {
@@ -1291 +1294 @@
                 }
 
-                /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-                $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
+                $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 );
 
                 if ( ! is_null( $auto_update_forced ) ) {

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

@@ -232 +232 @@
             $filter_payload = (object) array_merge( $filter_payload, array_intersect_key( $plugin_data, $filter_payload ) );
 
-            /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-            $auto_update_forced = apply_filters( 'auto_update_plugin', null, $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 );
+
             if ( ! is_null( $auto_update_forced ) ) {
                 $plugin_data['auto-update-forced'] = $auto_update_forced;

branches/5.5/src/wp-admin/includes/class-wp-site-health.php

@@ -2373 +2373 @@
         );
 
+        $type = 'plugin';
         /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
-        $test_plugins_enabled = apply_filters( 'auto_update_plugin', true, $mock_plugin );
+        $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_theme', true, $mock_theme );
+        $test_themes_enabled = apply_filters( "auto_update_{$type}", true, $mock_theme );
+
         $ui_enabled_for_plugins = wp_is_auto_update_enabled_for_type( 'plugin' );
         $ui_enabled_for_themes  = wp_is_auto_update_enabled_for_type( 'theme' );

branches/5.5/src/wp-admin/includes/theme.php

@@ -717 +717 @@
         }
 
-        /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
-        $auto_update_forced = apply_filters( 'auto_update_theme', null, $auto_update_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, $auto_update_filter_payload );
 
         $prepared_themes[ $slug ] = array(