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

trunk/src/wp-includes/post.php

@@ -8 +8 @@
 
 //
-// Post Type Registration
+// Post Type registration.
 //
 
@@ -716 +716 @@
  */
 function get_extended( $post ) {
-    //Match the new style more links.
+    // Match the new style more links.
     if ( preg_match( '/<!--more(.*?)?-->/', $post, $matches ) ) {
         list($main, $extended) = explode( $matches[0], $post, 2 );
@@ -726 +726 @@
     }
 
-    //  leading and trailing whitespace.
+    // Leading and trailing whitespace.
     $main      = preg_replace( '/^[\s]*(.*)[\s]*$/', '\\1', $main );
     $extended  = preg_replace( '/^[\s]*(.*)[\s]*$/', '\\1', $extended );
@@ -1417 +1417 @@
     }
 
-    // Sanitize post type name
+    // Sanitize post type name.
     $post_type = sanitize_key( $post_type );
 
@@ -1559 +1559 @@
 
     $default_capabilities = array(
-        // Meta capabilities
+        // Meta capabilities.
         'edit_post'          => 'edit_' . $singular_base,
         'read_post'          => 'read_' . $singular_base,
@@ -2034 +2034 @@
     if ( ! empty( $parsed_args['include'] ) ) {
         $incposts                      = wp_parse_id_list( $parsed_args['include'] );
-        $parsed_args['posts_per_page'] = count( $incposts );  // only the number of posts included
+        $parsed_args['posts_per_page'] = count( $incposts );  // Only the number of posts included.
         $parsed_args['post__in']       = $incposts;
     } elseif ( ! empty( $parsed_args['exclude'] ) ) {
@@ -2049 +2049 @@
 
 //
-// Post meta functions
+// Post meta functions.
 //
 
@@ -2714 +2714 @@
  */
 function get_post_mime_types() {
-    $post_mime_types = array(   //  array( adj, noun )
+    $post_mime_types = array(   // array( adj, noun )
         'image'       => array(
             __( 'Images' ),
@@ -4275 +4275 @@
     // Uh oh, someone jumped the gun!
     if ( $time > time() ) {
-        wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
+        wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // Clear anything else in the system.
         wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
         return;
@@ -4833 +4833 @@
 
 //
-// Page functions
+// Page functions.
 //
 
@@ -5267 +5267 @@
     $inclusions = '';
     if ( ! empty( $parsed_args['include'] ) ) {
-        $child_of     = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
+        $child_of     = 0; // Ignore child_of, parent, exclude, meta_key, and meta_value params if using include.
         $parent       = -1;
         $exclude      = '';
@@ -5293 +5293 @@
         if ( ! empty( $post_authors ) ) {
             foreach ( $post_authors as $post_author ) {
-                //Do we have an author id or an author login?
+                // Do we have an author id or an author login?
                 if ( 0 == intval( $post_author ) ) {
                     $post_author = get_user_by( 'login', $post_author );
@@ -5322 +5322 @@
         $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
 
-        // meta_key and meta_value might be slashed
+        // meta_key and meta_value might be slashed.
         $meta_key   = wp_unslash( $meta_key );
         $meta_value = wp_unslash( $meta_value );
@@ -5462 +5462 @@
     wp_cache_set( $cache_key, $page_structure, 'posts' );
 
-    // Convert to WP_Post instances
+    // Convert to WP_Post instances.
     $pages = array_map( 'get_post', $pages );
 
@@ -5477 +5477 @@
 
 //
-// Attachment functions
+// Attachment functions.
 //
 
@@ -5834 +5834 @@
                 $url = str_replace( $uploads['basedir'], $uploads['baseurl'], $file );
             } elseif ( false !== strpos( $file, 'wp-content/uploads' ) ) {
-                // Get the directory name relative to the basedir (back compat for pre-2.7 uploads)
+                // Get the directory name relative to the basedir (back compat for pre-2.7 uploads).
                 $url = trailingslashit( $uploads['baseurl'] . '/' . _wp_get_attachment_relative_path( $file ) ) . wp_basename( $file );
             } else {
@@ -6354 +6354 @@
                 } elseif ( $id == (int) $post_author ) {
                     $post_status_sql .= " OR post_status = 'private'";
-                } // else none
-            } // else none
+                } // Else none.
+            } // Else none.
         }
 
@@ -6713 +6713 @@
 
 //
-// Hooks
+// Hooks.
 //
 
@@ -6875 +6875 @@
     $loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent );
     if ( ! $loop ) {
-        return $post_parent; // No loop
+        return $post_parent; // No loop.
     }