Changeset 47122 for trunk/src/wp-admin/includes/class-wp-screen.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-screen.php (modified) (8 diffs)

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

@@ -227 +227 @@
         if ( $hook_name && post_type_exists( $hook_name ) ) {
             $post_type = $id;
-            $id        = 'post'; // changes later. ends up being $base.
+            $id        = 'post'; // Changes later. Ends up being $base.
         } else {
             if ( '.php' == substr( $id, -4 ) ) {
@@ -924 +924 @@
             </div>
         <?php
-        // Setup layout columns
+        // Setup layout columns.
 
         /**
@@ -953 +953 @@
         $GLOBALS['screen_layout_columns'] = $this->columns; // Set the global for back-compat.
 
-        // Add screen options
+        // Add screen options.
         if ( $this->show_screen_options() ) {
             $this->render_screen_options();
@@ -1157 +1157 @@
 
         foreach ( $columns as $column => $title ) {
-            // Can't hide these for they are special
+            // Can't hide these for they are special.
             if ( in_array( $column, $special ) ) {
                 continue;
@@ -1256 +1256 @@
         }
 
-        // Back compat
+        // Back compat.
         if ( isset( $this->post_type ) ) {
             /** This filter is documented in wp-admin/includes/post.php */
@@ -1262 +1262 @@
         }
 
-        // This needs a submit button
+        // This needs a submit button.
         add_filter( 'screen_options_show_submit', '__return_true' );
 
@@ -1289 +1289 @@
         $screen = get_current_screen();
 
-        // Currently only enabled for posts lists
+        // Currently only enabled for posts lists.
         if ( 'edit' !== $screen->base ) {
             return;
@@ -1317 +1317 @@
         global $mode;
 
-        // This needs a submit button
+        // This needs a submit button.
         add_filter( 'screen_options_show_submit', '__return_true' );
         ?>