Changeset 48097

Timestamp:

06/19/2020 10:15:36 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Corrections and improvements to inline docs related to plugin and theme auto-updates.

See #50052, #49572

Location:

trunk/src/wp-admin

Files:

• includes/class-wp-automatic-updater.php (modified) (4 diffs)
• includes/update.php (modified) (4 diffs)
• themes.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -871 +871 @@
          * @since 5.5.0
          *
-         * @param object $results The result of updates tasks.
+         * @param array $update_results The result of updates tasks.
          */
         protected function after_plugin_theme_update( $update_results ) {
@@ -933 +933 @@
          * @since 5.5.0
          *
-         * @param string $type               The type of email to send. Can be one of 'success', 'failure', 'mixed'.
+         * @param string $type               The type of email to send. Can be one of 'success', 'fail', 'mixed'.
          * @param array  $successful_updates A list of updates that succeeded.
          * @param array  $failed_updates     A list of updates that failed.
@@ -1025 +1025 @@
 
                 /**
-                 * Filters the email sent following an automatic background plugin update.
+                 * Filters the email sent following an automatic background update for plugins and themes.
                  *
                  * @since 5.5.0
                  *
-                 * @param array $email {
+                 * @param array  $email {
                  *     Array of email arguments that will be passed to wp_mail().
                  *
@@ -1040 +1040 @@
                  * @param string $type               The type of email being sent. Can be one of
                  *                                   'success', 'fail', 'mixed'.
-                 * @param object $successful_updates The updates that succeeded.
-                 * @param object $failed_updates     The updates that failed.
+                 * @param array  $successful_updates The updates that succeeded.
+                 * @param array  $failed_updates     The updates that failed.
                  */
                 $email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );

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

@@ -945 +945 @@
  * @since 5.5.0
  *
- * @param string $type    The type of update being checked: 'theme' or 'plugin'.
+ * @param string $type The type of update being checked: 'theme' or 'plugin'.
  * @return bool True if auto-updates are enabled for `$type`, false otherwise.
  */
@@ -952 +952 @@
                 case 'plugin':
                         /**
-                         * Filters whether plugins manual auto-update is enabled.
+                         * Filters whether plugins auto-update is enabled.
                          *
                          * @since 5.5.0
@@ -961 +961 @@
                 case 'theme':
                         /**
-                         * Filters whether plugins manual auto-update is enabled.
+                         * Filters whether themes auto-update is enabled.
                          *
                          * @since 5.5.0
                          *
-                         * @param bool True if themes auto-update is enabled, false otherwise.
+                         * @param bool $enabled True if themes auto-update is enabled, false otherwise.
                          */
                         return apply_filters( 'themes_auto_update_enabled', true );
@@ -974 +974 @@
 
 /**
- * Determines the appropriate update message to be displayed.
+ * Determines the appropriate auto-update message to be displayed.
  *
  * @since 5.5.0

trunk/src/wp-admin/themes.php

@@ -557 +557 @@
  * @since 5.5.0
  *
- * @return string Template
+ * @return string The template for displaying the auto-update setting link.
  */
 function wp_theme_auto_update_setting_template() {