Changeset 56174 for trunk/src/wp-admin/includes/ajax-actions.php

Timestamp:

07/09/2023 07:50:52 PM (17 months ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (5 diffs)

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

@@ -299 +299 @@
     $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'];
@@ -307 +309 @@
     }
 
-    // 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'];
@@ -1521 +1525 @@
     require_once ABSPATH . 'wp-admin/includes/nav-menu.php';
 
-    // For performance reasons, we omit some object properties from the checklist.
-    // The following is a hacky way to restore them when adding non-custom items.
+    /*
+     * For performance reasons, we omit some object properties from the checklist.
+     * The following is a hacky way to restore them when adding non-custom items.
+     */
     $menu_items_data = array();
 
@@ -2513 +2519 @@
     }
 
-    // Set a custom header with the attachment_id.
-    // Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+    /*
+     * Set a custom header with the attachment_id.
+     * Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+     */
     if ( ! headers_sent() ) {
         header( 'X-WP-Upload-Attachment-ID: ' . $attachment_id );
     }
 
-    // This can still be pretty slow and cause timeout or out of memory errors.
-    // The js that handles the response would need to also handle HTTP 500 errors.
+    /*
+     * This can still be pretty slow and cause timeout or out of memory errors.
+     * The js that handles the response would need to also handle HTTP 500 errors.
+     */
     wp_update_image_subsizes( $attachment_id );
 
@@ -3770 +3780 @@
 
     if ( is_ssl() && str_starts_with( $url, 'http://' ) ) {
-        // Admin is ssl and the user pasted non-ssl URL.
-        // Check if the provider supports ssl embeds and use that for the preview.
+        /*
+         * Admin is ssl and the user pasted non-ssl URL.
+         * Check if the provider supports ssl embeds and use that for the preview.
+         */
         $ssl_shortcode = preg_replace( '%^(\\[embed[^\\]]*\\])http://%i', '$1https://', $shortcode );
         $parsed        = $wp_embed->run_shortcode( $ssl_shortcode );