Changeset 47122 for trunk/src/wp-admin/includes/ajax-actions.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/ajax-actions.php (modified) (25 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -23 +23 @@
     $response = array();
 
-    // screen_id is the same as $current_screen->id and the JS global 'pagenow'.
+    // 'screen_id' is the same as $current_screen->id and the JS global 'pagenow'.
     if ( ! empty( $_POST['screen_id'] ) ) {
         $screen_id = sanitize_key( $_POST['screen_id'] );
@@ -273 +273 @@
     $return = array();
 
-    // Check the type of request
-    // Current allowed values are `add` and `search`
+    // Check the type of request.
+    // Current allowed values are `add` and `search`.
     if ( isset( $_REQUEST['autocomplete_type'] ) && 'search' === $_REQUEST['autocomplete_type'] ) {
         $type = $_REQUEST['autocomplete_type'];
@@ -281 +281 @@
     }
 
-    // Check the desired field for value
-    // Current allowed values are `user_email` and `user_login`
+    // Check the desired field for value.
+    // Current allowed values are `user_email` and `user_login`.
     if ( isset( $_REQUEST['autocomplete_field'] ) && 'user_email' === $_REQUEST['autocomplete_field'] ) {
         $field = $_REQUEST['autocomplete_field'];
@@ -289 +289 @@
     }
 
-    // Exclude current users of this blog
+    // Exclude current users of this blog.
     if ( isset( $_REQUEST['site_id'] ) ) {
         $id = absint( $_REQUEST['site_id'] );
@@ -434 +434 @@
     $url      = isset( $_POST['_url'] ) ? esc_url_raw( $_POST['_url'] ) : '';
 
-    // JS didn't send us everything we need to know. Just die with success message
+    // JS didn't send us everything we need to know. Just die with success message.
     if ( ! $total || ! $per_page || ! $page || ! $url ) {
         $time           = time();
@@ -483 +483 @@
     }
 
-    // Only do the expensive stuff on a page-break, and about 1 other time per page
+    // Only do the expensive stuff on a page-break, and about 1 other time per page.
     if ( 0 == $total % $per_page || 1 == mt_rand( 1, $per_page ) ) {
         $post_id = 0;
@@ -601 +601 @@
         $checked_categories[] = $cat_id;
 
-        if ( $parent ) { // Do these all at once in a second
+        if ( $parent ) { // Do these all at once in a second.
             continue;
         }
@@ -627 +627 @@
     }
 
-    if ( $parent ) { // Foncy - replace the parent and all its children
+    if ( $parent ) { // Foncy - replace the parent and all its children.
         $parent  = get_term( $parent, $taxonomy->name );
         $term_id = $parent->term_id;
 
-        while ( $parent->parent ) { // get the top parent
+        while ( $parent->parent ) { // Get the top parent.
             $parent = get_term( $parent->parent, $taxonomy->name );
             if ( is_wp_error( $parent ) ) {
@@ -717 +717 @@
         $r = wp_untrash_comment( $comment );
 
-        if ( ! isset( $_POST['comment_status'] ) || $_POST['comment_status'] != 'trash' ) { // undo trash, not in trash
+        // Undo trash, not in trash.
+        if ( ! isset( $_POST['comment_status'] ) || $_POST['comment_status'] != 'trash' ) {
             $delta = 1;
         }
@@ -733 +734 @@
         $r = wp_unspam_comment( $comment );
 
-        if ( ! isset( $_POST['comment_status'] ) || $_POST['comment_status'] != 'spam' ) { // undo spam, not in spam
+        // Undo spam, not in spam.
+        if ( ! isset( $_POST['comment_status'] ) || $_POST['comment_status'] != 'spam' ) {
             $delta = 1;
         }
@@ -742 +744 @@
     }
 
-    if ( $r ) { // Decide if we need to send back '1' or a more complicated response including page links and comment counts
+    if ( $r ) {
+        // Decide if we need to send back '1' or a more complicated response including page links and comment counts.
         _wp_ajax_delete_comment_response( $comment->comment_ID, $delta );
     }
@@ -990 +993 @@
     }
 
-    // Decide if we need to send back '1' or a more complicated response including page links and comment counts
+    // Decide if we need to send back '1' or a more complicated response including page links and comment counts.
     _wp_ajax_delete_comment_response( $comment->comment_ID );
     wp_die( 0 );
@@ -1162 +1165 @@
     }
 
-    // We need raw tag names here, so don't filter the output
+    // We need raw tag names here, so don't filter the output.
     $return = wp_generate_tag_cloud(
         $tags,
@@ -1289 +1292 @@
 
             if ( wp_create_nonce( 'unfiltered-html-comment' ) != $_POST['_wp_unfiltered_html_comment'] ) {
-                kses_remove_filters(); // start with a clean slate
-                kses_init_filters(); // set up the filters
+                kses_remove_filters(); // Start with a clean slate.
+                kses_init_filters();   // Set up the filters.
                 remove_filter( 'pre_comment_content', 'wp_filter_post_kses' );
                 add_filter( 'pre_comment_content', 'wp_filter_kses' );
@@ -1479 +1482 @@
             $_menu_item  = reset( $_menu_items );
 
-            // Restore the missing menu item properties
+            // Restore the missing menu item properties.
             $menu_item_data['menu-item-description'] = $_menu_item->description;
         }
@@ -1499 +1502 @@
             $menu_obj        = wp_setup_nav_menu_item( $menu_obj );
             $menu_obj->title = empty( $menu_obj->title ) ? __( 'Menu Item' ) : $menu_obj->title;
-            $menu_obj->label = $menu_obj->title; // don't show "(pending)" in ajax-added items
+            $menu_obj->label = $menu_obj->title; // Don't show "(pending)" in ajax-added items.
             $menu_items[]    = $menu_obj;
         }
@@ -1549 +1552 @@
         if ( $post->post_status == 'auto-draft' ) {
             $post_data                = array();
-            $post_data['action']      = 'draft'; // Warning fix
+            $post_data['action']      = 'draft'; // Warning fix.
             $post_data['post_ID']     = $pid;
             $post_data['post_type']   = $post->post_type;
@@ -1609 +1612 @@
 
         if ( ! $meta ) {
-            wp_die( 0 ); // if meta doesn't exist
+            wp_die( 0 ); // If meta doesn't exist.
         }
 
@@ -1732 +1735 @@
 
     if ( is_array( $hidden ) ) {
-        $hidden = array_diff( $hidden, array( 'submitdiv', 'linksubmitdiv', 'manage-menu', 'create-menu' ) ); // postboxes that are always shown
+        // Postboxes that are always shown.
+        $hidden = array_diff( $hidden, array( 'submitdiv', 'linksubmitdiv', 'manage-menu', 'create-menu' ) );
         update_user_option( $user->ID, "metaboxhidden_$page", $hidden, true );
     }
@@ -2621 +2625 @@
  */
 function wp_ajax_set_post_thumbnail() {
-    $json = ! empty( $_REQUEST['json'] ); // New-style request
+    $json = ! empty( $_REQUEST['json'] ); // New-style request.
 
     $post_ID = intval( $_POST['post_id'] );
@@ -3227 +3231 @@
     } else {
         $html = isset( $attachment['post_title'] ) ? $attachment['post_title'] : '';
-        $rel  = $rel ? ' rel="attachment wp-att-' . $id . '"' : ''; // Hard-coded string, $id is already sanitized
+        $rel  = $rel ? ' rel="attachment wp-att-' . $id . '"' : ''; // Hard-coded string, $id is already sanitized.
 
         if ( ! empty( $url ) ) {
@@ -3288 +3292 @@
 
     if ( $check_embed !== $fallback ) {
-        // TinyMCE view for [embed] will parse this
+        // TinyMCE view for [embed] will parse this.
         $html = '[embed]' . $src . '[/embed]';
     } elseif ( $link_text ) {
@@ -3328 +3332 @@
     $nonce_state = wp_verify_nonce( $_POST['_nonce'], 'heartbeat-nonce' );
 
-    // screen_id is the same as $current_screen->id and the JS global 'pagenow'.
+    // 'screen_id' is the same as $current_screen->id and the JS global 'pagenow'.
     if ( ! empty( $_POST['screen_id'] ) ) {
         $screen_id = sanitize_key( $_POST['screen_id'] );
@@ -3393 +3397 @@
     do_action( 'heartbeat_tick', $response, $screen_id );
 
-    // Send the current time according to the server
+    // Send the current time according to the server.
     $response['server_time'] = time();
 
@@ -3736 +3740 @@
     }
 
-    // the embed shortcode requires a post
+    // The embed shortcode requires a post.
     if ( ! $post || ! current_user_can( 'edit_post', $post->ID ) ) {
         if ( 'embed' === $shortcode ) {