Changeset 48408

Timestamp:

07/08/2020 01:13:50 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections.

See #49572.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-automatic-updater.php (modified) (5 diffs)
• wp-includes/meta.php (modified) (1 diff)
• wp-includes/nav-menu-template.php (modified) (2 diffs)
• wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (1 diff)
• wp-includes/widgets.php (modified) (1 diff)

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

@@ -945 +945 @@
         $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
 
-        // When only failures have occurred, an email should only be sent if there are unique failures.
-        // A failure is considered unique if an email has not been sent for an update attempt failure
-        // to a plugin or theme with the same new_version.
+        /*
+         * When only failures have occurred, an email should only be sent if there are unique failures.
+         * A failure is considered unique if an email has not been sent for an update attempt failure
+         * to a plugin or theme with the same new_version.
+         */
         if ( 'fail' === $type ) {
             foreach ( $failed_updates as $update_type => $failures ) {
@@ -1044 +1046 @@
 
                 foreach ( $failed_updates['plugin'] as $item ) {
-                    $body[]                                     = "- {$item->name}";
+                    $body[] = "- {$item->name}";
+
                     $past_failure_emails[ $item->item->plugin ] = $item->item->new_version;
                 }
+
                 $body[] = "\n";
             }
@@ -1055 +1059 @@
 
                 foreach ( $failed_updates['theme'] as $item ) {
-                    $body[]                                    = "- {$item->name}";
+                    $body[] = "- {$item->name}";
+
                     $past_failure_emails[ $item->item->theme ] = $item->item->new_version;
                 }
+
                 $body[] = "\n";
             }
@@ -1072 +1078 @@
                 foreach ( $successful_updates['plugin'] as $item ) {
                     $body[] = "- {$item->name}";
+
                     unset( $past_failure_emails[ $item->item->plugin ] );
                 }
+
                 $body[] = "\n";
             }
@@ -1080 +1088 @@
             if ( ! empty( $successful_updates['theme'] ) ) {
                 $body[] = __( 'These themes are now up to date:' );
-                // List successful updates.
+
                 foreach ( $successful_updates['theme'] as $item ) {
                     $body[] = "- {$item->name}";
+
                     unset( $past_failure_emails[ $item->item->theme ] );
                 }
+
                 $body[] = "\n";
             }

trunk/src/wp-includes/meta.php

@@ -1227 +1227 @@
  *     @type string     $description       A description of the data attached to this meta key.
  *     @type bool       $single            Whether the meta key has one value per object, or an array of values per object.
- *     @type mixed      $default           The default value returned from {@see get_metadata()} if no value has been set yet.
- *                                         When using a non-single meta key, the default value is for the first entry. In other
- *                                         words, when calling {@see get_metadata()} with `$single` set to `false`, the default
- *                                         value given here will be wrapped in an array.
+ *     @type mixed      $default           The default value returned from get_metadata() if no value has been set yet.
+ *                                         When using a non-single meta key, the default value is for the first entry.
+ *                                         In other words, when calling get_metadata() with `$single` set to `false`,
+ *                                         the default value given here will be wrapped in an array.
  *     @type string     $sanitize_callback A function or method to call when sanitizing `$meta_key` data.
  *     @type string     $auth_callback     Optional. A function or method to call when performing edit_post_meta,

trunk/src/wp-includes/nav-menu-template.php

@@ -302 +302 @@
 
 /**
- * Add the class property classes for the current context, if applicable.
+ * Adds the class property classes for the current context, if applicable.
  *
  * @access private
@@ -593 +593 @@
 
 /**
- * Retrieve the HTML list content for nav menu items.
+ * Retrieves the HTML list content for nav menu items.
  *
  * @uses Walker_Nav_Menu to create HTML list content.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -461 +461 @@
         }
 
-        // If the file doesn't exist, attempt a URL fopen on the src link.
-        // This can occur with certain file replication plugins.
-        // Keep the original file path to get a modified name later.
+        /*
+         * If the file doesn't exist, attempt a URL fopen on the src link.
+         * This can occur with certain file replication plugins.
+         * Keep the original file path to get a modified name later.
+         */
         $image_file_to_edit = $image_file;
         if ( ! file_exists( $image_file_to_edit ) ) {

trunk/src/wp-includes/widgets.php

@@ -1657 +1657 @@
     </p>
     <?php
-    endif; // end of display options
+    endif; // End of display options.
 foreach ( array_keys( $default_inputs ) as $input ) :
     if ( 'hidden' === $inputs[ $input ] ) :