Changeset 47122 for trunk/src/wp-admin/install.php

Timestamp:

01/29/2020 12:43:23 AM (7 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/install.php (modified) (7 diffs)

trunk/src/wp-admin/install.php

@@ -78 +78 @@
 
         <?php
-} // end display_header()
+} // End display_header().
 
 /**
@@ -95 +95 @@
         $user_table = ( $wpdb->get_var( $sql ) != null );
 
-        // Ensure that Blogs appear in search engines by default.
+        // Ensure that sites appear in search engines by default.
         $blog_public = 1;
         if ( isset( $_POST['weblog_title'] ) ) {
@@ -210 +210 @@
 </form>
         <?php
-} // end display_setup_form()
+} // End display_setup_form().
 
 // Let's check to make sure WP isn't already installed.
@@ -304 +304 @@
 
 switch ( $step ) {
-        case 0: // Step 0
+        case 0: // Step 0.
                 if ( wp_can_install_language_pack() && empty( $language ) ) {
                         $languages = wp_get_available_translations();
@@ -356 +356 @@
 
                 display_header();
-                // Fill in the data we gathered
+                // Fill in the data we gathered.
                 $weblog_title         = isset( $_POST['weblog_title'] ) ? trim( wp_unslash( $_POST['weblog_title'] ) ) : '';
                 $user_name            = isset( $_POST['user_name'] ) ? trim( wp_unslash( $_POST['user_name'] ) ) : '';
@@ -367 +367 @@
                 $error = false;
                 if ( empty( $user_name ) ) {
-                        // TODO: poka-yoke
+                        // TODO: Poka-yoke.
                         display_setup_form( __( 'Please provide a valid username.' ) );
                         $error = true;
@@ -374 +374 @@
                         $error = true;
                 } elseif ( $admin_password != $admin_password_check ) {
-                        // TODO: poka-yoke
+                        // TODO: Poka-yoke.
                         display_setup_form( __( 'Your passwords do not match. Please try again.' ) );
                         $error = true;
                 } elseif ( empty( $admin_email ) ) {
-                        // TODO: poka-yoke
+                        // TODO: Poka-yoke.
                         display_setup_form( __( 'You must provide an email address.' ) );
                         $error = true;
                 } elseif ( ! is_email( $admin_email ) ) {
-                        // TODO: poka-yoke
+                        // TODO: Poka-yoke.
                         display_setup_form( __( 'Sorry, that isn&#8217;t a valid email address. Email addresses look like <code>username@example.com</code>.' ) );
                         $error = true;