Changeset 47084 for trunk/src/wp-admin/includes/dashboard.php

Timestamp:

01/18/2020 12:52:28 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve comments in some wp-admin files per the documentation standards.

Props passoniate.
Fixes #49215, #49216.

File:

• trunk/src/wp-admin/includes/dashboard.php (modified) (12 diffs)

trunk/src/wp-admin/includes/dashboard.php

@@ -57 +57 @@
     }
 
-    // Right Now
+    // Right Now.
     if ( is_blog_admin() && current_user_can( 'edit_posts' ) ) {
         wp_add_dashboard_widget( 'dashboard_right_now', __( 'At a Glance' ), 'wp_dashboard_right_now' );
@@ -66 +66 @@
     }
 
-    // Activity Widget
+    // Activity Widget.
     if ( is_blog_admin() ) {
         wp_add_dashboard_widget( 'dashboard_activity', __( 'Activity' ), 'wp_dashboard_site_activity' );
     }
 
-    // QuickPress Widget
+    // QuickPress Widget.
     if ( is_blog_admin() && current_user_can( get_post_type_object( 'post' )->cap->create_posts ) ) {
         $quick_draft_title = sprintf( '<span class="hide-if-no-js">%1$s</span> <span class="hide-if-js">%2$s</span>', __( 'Quick Draft' ), __( 'Your Recent Drafts' ) );
@@ -77 +77 @@
     }
 
-    // WordPress Events and News
+    // WordPress Events and News.
     wp_add_dashboard_widget( 'dashboard_primary', __( 'WordPress Events and News' ), 'wp_dashboard_events_news' );
 
@@ -140 +140 @@
     if ( 'POST' == $_SERVER['REQUEST_METHOD'] && isset( $_POST['widget_id'] ) ) {
         check_admin_referer( 'edit-dashboard-widget_' . $_POST['widget_id'], 'dashboard-widget-nonce' );
-        ob_start(); // hack - but the same hack wp-admin/widgets.php uses
+        ob_start(); // Hack - but the same hack wp-admin/widgets.php uses.
         wp_dashboard_trigger_widget_control( $_POST['widget_id'] );
         ob_end_clean();
@@ -279 +279 @@
     <ul>
     <?php
-    // Posts and Pages
+    // Posts and Pages.
     foreach ( array( 'post', 'page' ) as $post_type ) {
         $num_posts = wp_count_posts( $post_type );
@@ -299 +299 @@
         }
     }
-    // Comments
+    // Comments.
     $num_comm = wp_count_comments();
     if ( $num_comm && ( $num_comm->approved || $num_comm->moderated ) ) {
@@ -507 +507 @@
 
     /* Check if a new auto-draft (= no new post_ID) is needed or if the old can be used */
-    $last_post_id = (int) get_user_option( 'dashboard_quick_press_last_post_id' ); // Get the last post_ID
+    $last_post_id = (int) get_user_option( 'dashboard_quick_press_last_post_id' ); // Get the last post_ID.
     if ( $last_post_id ) {
         $post = get_post( $last_post_id );
-        if ( empty( $post ) || $post->post_status != 'auto-draft' ) { // auto-draft doesn't exists anymore
+        if ( empty( $post ) || $post->post_status != 'auto-draft' ) { // auto-draft doesn't exists anymore.
             $post = get_default_post_to_edit( 'post', true );
-            update_user_option( get_current_user_id(), 'dashboard_quick_press_last_post_id', (int) $post->ID ); // Save post_ID
+            update_user_option( get_current_user_id(), 'dashboard_quick_press_last_post_id', (int) $post->ID ); // Save post_ID.
         } else {
-            $post->post_title = ''; // Remove the auto draft title
+            $post->post_title = ''; // Remove the auto draft title.
         }
     } else {
@@ -521 +521 @@
         // Don't create an option if this is a super admin who does not belong to this site.
         if ( in_array( get_current_blog_id(), array_keys( get_blogs_of_user( $user_id ) ) ) ) {
-            update_user_option( $user_id, 'dashboard_quick_press_last_post_id', (int) $post->ID ); // Save post_ID
+            update_user_option( $user_id, 'dashboard_quick_press_last_post_id', (int) $post->ID ); // Save post_ID.
         }
     }
@@ -761 +761 @@
             ( ( ( 'approve' == $action || 'unapprove' == $action ) && 2 === $i ) || 1 === $i ) ? $sep = '' : $sep = ' | ';
 
-            // Reply and quickedit need a hide-if-no-js span
+            // Reply and quickedit need a hide-if-no-js span.
             if ( 'reply' == $action || 'quickedit' == $action ) {
                 $action .= ' hide-if-no-js';
@@ -1109 +1109 @@
         ob_start();
         call_user_func_array( $callback, $args );
-        set_transient( $cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS ); // Default lifetime in cache of 12 hours (same as the feeds)
+        // Default lifetime in cache of 12 hours (same as the feeds).
+        set_transient( $cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS );
     }
 
@@ -1164 +1165 @@
     }
 
-    $number                                 = 1; // Hack to use wp_widget_rss_form()
+    $number = 1; // Hack to use wp_widget_rss_form().
+
     $widget_options[ $widget_id ]['number'] = $number;
 
@@ -1663 +1665 @@
     $response = get_site_transient( 'browser_' . $key );
     if ( false === $response ) {
-        // include an unmodified $wp_version
+        // Include an unmodified $wp_version.
         include( ABSPATH . WPINC . '/version.php' );