Changeset 48446

Timestamp:

07/12/2020 01:17:51 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections for plugin and theme updates.

See #49572.

Location:

trunk/src/wp-admin/includes

Files:

• ajax-actions.php (modified) (1 diff)
• class-plugin-installer-skin.php (modified) (1 diff)
• class-plugin-upgrader.php (modified) (2 diffs)
• class-theme-installer-skin.php (modified) (1 diff)
• class-theme-upgrader.php (modified) (2 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -4467 +4467 @@
                  * Plugin is already at the latest version.
                  *
-                 * This may also be the return value If the `update_plugins` site transient is empty,
+                 * This may also be the return value if the `update_plugins` site transient is empty,
                  * e.g. when you update two plugins in quick succession before the transient repopulates.
                  *

trunk/src/wp-admin/includes/class-plugin-installer-skin.php

@@ -233 +233 @@
 
                 /**
-                 * Filters the compare table output for overwrite a plugin package on upload.
+                 * Filters the compare table output for overwriting a plugin package on upload.
                  *
                  * @since 5.5.0
                  *
-                 * @param string   $table                The output table with Name, Version, Author, RequiresWP and RequiresPHP info.
-                 * @param array    $current_plugin_data  Array with current plugin data.
-                 * @param array    $new_plugin_data      Array with uploaded plugin data.
+                 * @param string $table               The output table with Name, Version, Author, RequiresWP, and RequiresPHP info.
+                 * @param array  $current_plugin_data Array with current plugin data.
+                 * @param array  $new_plugin_data     Array with uploaded plugin data.
                  */
                 echo apply_filters( 'install_plugin_ovewrite_comparison', $table, $current_plugin_data, $this->upgrader->new_plugin_data );

trunk/src/wp-admin/includes/class-plugin-upgrader.php

@@ -248 +248 @@
                 wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
 
-                // Ensure any future auto-update failures trigger a failure email by removing the last
-                // failure notification from the list when plugins update successfully.
+                // Ensure any future auto-update failures trigger a failure email by removing
+                // the last failure notification from the list when plugins update successfully.
                 $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
 
@@ -380 +380 @@
                 remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );
 
-                // Ensure any future auto-update failures trigger a failure email by removing the last
-                // failure notification from the list when plugins update successfully.
+                // Ensure any future auto-update failures trigger a failure email by removing
+                // the last failure notification from the list when plugins update successfully.
                 $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
 

trunk/src/wp-admin/includes/class-theme-installer-skin.php

@@ -268 +268 @@
 
                 /**
-                 * Filters the compare table output for overwrite a theme package on upload.
+                 * Filters the compare table output for overwriting a theme package on upload.
                  *
                  * @since 5.5.0
                  *
-                 * @param string   $table               The output table with Name, Version, Author, RequiresWP and RequiresPHP info.
-                 * @param array    $current_theme_data  Array with current theme data.
-                 * @param array    $new_theme_data      Array with uploaded theme data.
+                 * @param string $table              The output table with Name, Version, Author, RequiresWP, and RequiresPHP info.
+                 * @param array  $current_theme_data Array with current theme data.
+                 * @param array  $new_theme_data     Array with uploaded theme data.
                  */
                 echo apply_filters( 'install_theme_overwrite_comparison', $table, $current_theme_data, $this->upgrader->new_theme_data );

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

@@ -353 +353 @@
                 wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
 
-                // Ensure any future auto-update failures trigger a failure email by removing the last
-                // failure notification from the list when themes update successfully.
+                // Ensure any future auto-update failures trigger a failure email by removing
+                // the last failure notification from the list when themes update successfully.
                 $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
 
@@ -489 +489 @@
                 remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_theme' ) );
 
-                // Ensure any future auto-update failures trigger a failure email by removing the last
-                // failure notification from the list when themes update successfully.
+                // Ensure any future auto-update failures trigger a failure email by removing
+                // the last failure notification from the list when themes update successfully.
                 $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );