Changeset 47122 for trunk/src/wp-includes/deprecated.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-includes/deprecated.php (modified) (17 diffs)

trunk/src/wp-includes/deprecated.php

@@ -271 +271 @@
     _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
 
-    // right now if one can edit, one can delete
+    // Right now if one can edit, one can delete.
     return user_can_edit_post($user_id, $post_id, $blog_id);
 }
@@ -328 +328 @@
     _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
 
-    // right now if one can edit a post, one can edit comments made on it
+    // Right now if one can edit a post, one can edit comments made on it.
     return user_can_edit_post($user_id, $post_id, $blog_id);
 }
@@ -347 +347 @@
     _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
 
-    // right now if one can edit comments, one can delete comments
+    // Right now if one can edit comments, one can delete comments.
     return user_can_edit_post_comments($user_id, $post_id, $blog_id);
 }
@@ -932 +932 @@
     }
 
-    if ( $category == -1 ) //get_bookmarks uses '' to signify all categories
+    if ( $category == -1 ) // get_bookmarks() uses '' to signify all categories.
         $category = '';
 
@@ -977 +977 @@
             if ( strpos($row->link_image, 'http') !== false )
                 $output .= "<img src=\"$row->link_image\" $alt $title />";
-            else // If it's a relative path
+            else // If it's a relative path.
                 $output .= "<img src=\"" . get_option('siteurl') . "$row->link_image\" $alt $title />";
         } else {
@@ -996 +996 @@
 
         $output .= "$after\n";
-    } // end while
+    } // End while.
 
     if ( !$echo )
@@ -1020 +1020 @@
     $order = strtolower($order);
 
-    // Handle link category sorting
+    // Handle link category sorting.
     $direction = 'ASC';
     if ( '_' == substr($order,0,1) ) {
@@ -1032 +1032 @@
     $cats = get_categories(array('type' => 'link', 'orderby' => $order, 'order' => $direction, 'hierarchical' => 0));
 
-    // Display each category
+    // Display each category.
     if ( $cats ) {
         foreach ( (array) $cats as $cat ) {
             // Handle each category.
 
-            // Display the category name
+            // Display the category name.
             echo '  <li id="linkcat-' . $cat->term_id . '" class="linkcat"><h2>' . apply_filters('link_category', $cat->name ) . "</h2>\n\t<ul>\n";
-            // Call get_links() with all the appropriate params
+            // Call get_links() with all the appropriate params.
             get_links($cat->term_id, '<li>', "</li>", "\n", true, 'name', false);
 
-            // Close the last category
+            // Close the last category.
             echo "\n\t</ul>\n</li>\n";
         }
@@ -1255 +1255 @@
 
     $chain = '';
-    /** TODO: consult hierarchy */
+    /** TODO: Consult hierarchy */
     $cat_ids = get_all_category_ids();
     foreach ( (array) $cat_ids as $cat_id ) {
@@ -1878 +1878 @@
 
     if ( !$fullsize && $src = wp_get_attachment_thumb_url( $post->ID ) ) {
-        // We have a thumbnail desired, specified and existing
+        // We have a thumbnail desired, specified and existing.
 
         $src_file = wp_basename($src);
     } elseif ( wp_attachment_is_image( $post->ID ) ) {
-        // We have an image without a thumbnail
+        // We have an image without a thumbnail.
 
         $src = wp_get_attachment_url( $post->ID );
@@ -2114 +2114 @@
 function register_sidebar_widget($name, $output_callback, $classname = '', ...$params) {
     _deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' );
-    // Compat
+    // Compat.
     if ( is_array( $name ) ) {
         if ( count( $name ) === 3 ) {
@@ -2168 +2168 @@
 function register_widget_control($name, $control_callback, $width = '', $height = '', ...$params) {
     _deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_widget_control()' );
-    // Compat
+    // Compat.
     if ( is_array( $name ) ) {
         if ( count( $name ) === 3 ) {
@@ -2272 +2272 @@
         $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
         $user = wp_cache_get($user_id, 'users');
-        // Check the cached user object
+        // Check the cached user object.
         if ( false !== $user && isset($user->$meta_key) )
             $metas = array($user->$meta_key);
@@ -2395 +2395 @@
         add_theme_support( 'automatic-feed-links' );
     else
-        remove_action( 'wp_head', 'feed_links_extra', 3 ); // Just do this yourself in 3.0+
+        remove_action( 'wp_head', 'feed_links_extra', 3 ); // Just do this yourself in 3.0+.
 }
 
@@ -2671 +2671 @@
 
     $posts = get_boundary_post($in_same_cat, $excluded_categories, $start);
-    // If there is no post stop.
+    // If there is no post, stop.
     if ( empty($posts) )
         return;
 
-    // Even though we limited get_posts to return only 1 item it still returns an array of objects.
+    // Even though we limited get_posts() to return only 1 item it still returns an array of objects.
     $post = $posts[0];
 
@@ -3597 +3597 @@
 
     if ( !empty($output) )
-        $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // convert only < > &
+        $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // Convert only '< > &'.
 
     /**
@@ -3674 +3674 @@
         return $headers;
 
-    // GET request - write it to the supplied filename
+    // GET request - write it to the supplied filename.
     $out_fp = fopen($file_path, 'w');
     if ( !$out_fp )