Changeset 47122 for trunk/src/wp-admin/includes/class-wp-importer.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/class-wp-importer.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-importer.php

@@ -26 +26 @@
         $offset = 0;
 
-        // Grab all posts in chunks
+        // Grab all posts in chunks.
         do {
             $meta_key = $importer_name . '_' . $bid . '_permalink';
@@ -32 +32 @@
             $results  = $wpdb->get_results( $sql );
 
-            // Increment offset
+            // Increment offset.
             $offset = ( $limit + $offset );
 
             if ( ! empty( $results ) ) {
                 foreach ( $results as $r ) {
-                    // Set permalinks into array
+                    // Set permalinks into array.
                     $hashtable[ $r->meta_value ] = intval( $r->post_id );
                 }
@@ -63 +63 @@
         $count = 0;
 
-        // Get count of permalinks
+        // Get count of permalinks.
         $meta_key = $importer_name . '_' . $bid . '_permalink';
         $sql      = $wpdb->prepare( "SELECT COUNT( post_id ) AS cnt FROM $wpdb->postmeta WHERE meta_key = %s", $meta_key );
@@ -95 +95 @@
         $offset = 0;
 
-        // Grab all comments in chunks
+        // Grab all comments in chunks.
         do {
             $sql     = $wpdb->prepare( "SELECT comment_ID, comment_agent FROM $wpdb->comments LIMIT %d,%d", $offset, $limit );
             $results = $wpdb->get_results( $sql );
 
-            // Increment offset
+            // Increment offset.
             $offset = ( $limit + $offset );
 
             if ( ! empty( $results ) ) {
                 foreach ( $results as $r ) {
-                    // Explode comment_agent key
+                    // Explode comment_agent key.
                     list ( $ca_bid, $source_comment_id ) = explode( '-', $r->comment_agent );
                     $source_comment_id                   = intval( $source_comment_id );
 
-                    // Check if this comment came from this blog
+                    // Check if this comment came from this blog.
                     if ( $bid == $ca_bid ) {
                         $hashtable[ $source_comment_id ] = intval( $r->comment_ID );
@@ -204 +204 @@
      */
     public function get_page( $url, $username = '', $password = '', $head = false ) {
-        // Increase the timeout
+        // Increase the timeout.
         add_filter( 'http_request_timeout', array( $this, 'bump_request_timeout' ) );
 
@@ -268 +268 @@
         // Or define( 'WP_IMPORTING', true );
         $wpdb->queries = array();
-        // Reset $wp_actions to keep it from growing out of control
+        // Reset $wp_actions to keep it from growing out of control.
         $wp_actions = array();
     }
@@ -318 +318 @@
     }
 
-    // Check array for specified param
+    // Check array for specified param.
     if ( isset( $out[ $param ] ) ) {
-        // Set return value
+        // Set return value.
         $return = $out[ $param ];
     }
 
-    // Check for missing required param
+    // Check for missing required param.
     if ( ! isset( $out[ $param ] ) && $required ) {
-        // Display message and exit
+        // Display message and exit.
         echo "\"$param\" parameter is required but was not specified\n";
         exit();