Changeset 47122 for trunk/src/wp-includes/link-template.php

Timestamp:

01/29/2020 12:43:23 AM (7 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/link-template.php (modified) (10 diffs)

trunk/src/wp-includes/link-template.php

@@ -196 +196 @@
                                 }
                         }
-                        // show default category in permalinks, without
-                        // having to assign it explicitly
+                        // Show default category in permalinks,
+                        // without having to assign it explicitly.
                         if ( empty( $category ) ) {
                                 $default_category = get_term( get_option( 'default_category' ), 'category' );
@@ -233 +233 @@
                 $permalink = user_trailingslashit( $permalink, 'single' );
 
-        } else { // if they're not using the fancy permalink option
+        } else { // If they're not using the fancy permalink option.
                 $permalink = home_url( '?p=' . $post->ID );
         }
@@ -424 +424 @@
         if ( $wp_rewrite->using_permalinks() && $parent ) {
                 if ( 'page' == $parent->post_type ) {
-                        $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front
+                        $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front.
                 } else {
                         $parentlink = get_permalink( $post->post_parent );
@@ -430 +430 @@
 
                 if ( is_numeric( $post->post_name ) || false !== strpos( get_option( 'permalink_structure' ), '%category%' ) ) {
-                        $name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker
+                        $name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker.
                 } else {
                         $name = $post->post_name;
@@ -1088 +1088 @@
  * Retrieves the permalink for a search.
  *
- * @since  3.0.0
+ * @since 3.0.0
  *
  * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
@@ -1650 +1650 @@
 }
 
-// Navigation links
+//
+// Navigation links.
+//
 
 /**
@@ -2514 +2516 @@
                 $paged         = get_query_var( 'paged' );
 
-                //only have sep if there's both prev and next results
+                // Only have sep if there's both prev and next results.
                 if ( $paged < 2 || $paged >= $max_num_pages ) {
                         $args['sep'] = '';
@@ -3882 +3884 @@
         $shortlink = '';
 
-        // Return p= link for all public post types.
+        // Return `?p=` link for all public post types.
         if ( ! empty( $post_id ) ) {
                 $post_type = get_post_type_object( $post->post_type );
@@ -4092 +4094 @@
                         'rating'         => get_option( 'avatar_rating' ),
                         'scheme'         => null,
-                        'processed_args' => null, // if used, should be a reference
+                        'processed_args' => null, // If used, should be a reference.
                         'extra_attr'     => '',
                 )
@@ -4178 +4180 @@
         } elseif ( is_string( $id_or_email ) ) {
                 if ( strpos( $id_or_email, '@md5.gravatar.com' ) ) {
-                        // md5 hash
+                        // MD5 hash.
                         list( $email_hash ) = explode( '@', $id_or_email );
                 } else {
-                        // email address
+                        // Email address.
                         $email = $id_or_email;
                 }
         } elseif ( $id_or_email instanceof WP_User ) {
-                // User Object
+                // User object.
                 $user = $id_or_email;
         } elseif ( $id_or_email instanceof WP_Post ) {
-                // Post Object
+                // Post object.
                 $user = get_user_by( 'id', (int) $id_or_email->post_author );
         } elseif ( $id_or_email instanceof WP_Comment ) {