Changeset 54212

Timestamp:

09/19/2022 08:26:09 PM (2 years ago)

Author:

davidbaumwald

Message:

Upgrade/Install: Add plugin URL to the automatic update email.

For each automatic plugin update, both successful and failed, information about each plugin is included in the email upon completion of the process. This change adds the plugin URL, if known, to the information included for each plugin that was processed.

This change also adds unit tests to validate the email contents after various automatic plugin update scenarios.

Props JosVelasco, pbiron, oliverstapelfeldt, ChrisHardie, Ipstenu, dd32, peterwilsoncc, audrasjb, costdev.
Fixes #53049.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-automatic-updater.php (modified) (2 diffs)
• tests/phpunit/tests/admin/wpAutomaticUpdater.php (added)

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

@@ -1102 +1102 @@
 
                 foreach ( $failed_updates['plugin'] as $item ) {
+                    $body_message = '';
+                    $item_url     = '';
+
+                    if ( ! empty( $item->item->url ) ) {
+                        $item_url = ' : ' . esc_url( $item->item->url );
+                    }
+
                     if ( $item->item->current_version ) {
-                        $body[] = sprintf(
-                            /* translators: 1: Plugin name, 2: Current version number, 3: New version number. */
-                            __( '- %1$s (from version %2$s to %3$s)' ),
+                        $body_message .= sprintf(
+                            /* translators: 1: Plugin name, 2: Current version number, 3: New version number, 4: Plugin URL. */
+                            __( '- %1$s (from version %2$s to %3$s)%4$s' ),
                             $item->name,
                             $item->item->current_version,
-                            $item->item->new_version
+                            $item->item->new_version,
+                            $item_url
                         );
                     } else {
-                        $body[] = sprintf(
-                            /* translators: 1: Plugin name, 2: Version number. */
-                            __( '- %1$s version %2$s' ),
+                        $body_message .= sprintf(
+                            /* translators: 1: Plugin name, 2: Version number, 3: Plugin URL. */
+                            __( '- %1$s version %2$s%3$s' ),
                             $item->name,
-                            $item->item->new_version
+                            $item->item->new_version,
+                            $item_url
                         );
                     }
+
+                    $body[] = $body_message;
 
                     $past_failure_emails[ $item->item->plugin ] = $item->item->new_version;
@@ -1163 +1174 @@
 
                 foreach ( $successful_updates['plugin'] as $item ) {
+                    $body_message = '';
+                    $item_url     = '';
+
+                    if ( ! empty( $item->item->url ) ) {
+                        $item_url = ' : ' . esc_url( $item->item->url );
+                    }
+
                     if ( $item->item->current_version ) {
-                        $body[] = sprintf(
-                            /* translators: 1: Plugin name, 2: Current version number, 3: New version number. */
-                            __( '- %1$s (from version %2$s to %3$s)' ),
+                        $body_message .= sprintf(
+                            /* translators: 1: Plugin name, 2: Current version number, 3: New version number, 4: Plugin URL. */
+                            __( '- %1$s (from version %2$s to %3$s)%4$s' ),
                             $item->name,
                             $item->item->current_version,
-                            $item->item->new_version
+                            $item->item->new_version,
+                            $item_url
                         );
                     } else {
-                        $body[] = sprintf(
-                            /* translators: 1: Plugin name, 2: Version number. */
-                            __( '- %1$s version %2$s' ),
+                        $body_message .= sprintf(
+                            /* translators: 1: Plugin name, 2: Version number, 3: Plugin URL. */
+                            __( '- %1$s version %2$s%3$s' ),
                             $item->name,
-                            $item->item->new_version
+                            $item->item->new_version,
+                            $item_url
                         );
                     }
+                    $body[] = $body_message;
 
                     unset( $past_failure_emails[ $item->item->plugin ] );