enmi-conf.org: comparison wp/wp-includes/link-template.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if
 * site is not set to have them.
 *
 * @since 2.2.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string $string      URL with or without a trailing slash.
 * @param string $type_of_url Optional. The type of URL being considered (e.g. single, category, etc)
 *                            for use in the filter. Default empty string.
 * @return string The URL with the trailing slash appended or stripped.
 *
 * @see get_permalink()
 *
 * @param int|WP_Post $post      Optional. Post ID or post object. Default is the global `$post`.
 * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
-*
 * @return string|false The permalink URL or false if post does not exist.
 */
 function get_the_permalink( $post = 0, $leavename = false ) {
 	return get_permalink( $post, $leavename );
 }
 		'%category%',
 		'%author%',
 		$leavename ? '' : '%pagename%',
 	);
-	if ( is_object( $post ) && isset( $post->filter ) && 'sample' == $post->filter ) {
+	if ( is_object( $post ) && isset( $post->filter ) && 'sample' === $post->filter ) {
 		$sample = true;
 	} else {
 		$post   = get_post( $post );
 		$sample = false;
 	}
 	if ( empty( $post->ID ) ) {
 		return false;
 	}
-	if ( $post->post_type == 'page' ) {
+	if ( 'page' === $post->post_type ) {
 		return get_page_link( $post, $leavename, $sample );
-	} elseif ( $post->post_type == 'attachment' ) {
+	} elseif ( 'attachment' === $post->post_type ) {
 		return get_attachment_link( $post, $leavename );
-	} elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ) ) ) {
+	} elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ), true ) ) {
 		return get_post_permalink( $post, $leavename, $sample );
 	}
 	$permalink = get_option( 'permalink_structure' );
 	 * @param WP_Post $post      The post in question.
 	 * @param bool    $leavename Whether to keep the post name.
 	 */
 	$permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename );
-	if ( '' != $permalink && ! in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ) ) ) {
+	if ( $permalink && ! in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ), true ) ) {
-		$unixtime = strtotime( $post->post_date );
 		$category = '';
 		if ( strpos( $permalink, '%category%' ) !== false ) {
 			$cats = get_the_category( $post->ID );
 			if ( $cats ) {
 				$category        = $category_object->slug;
 				if ( $category_object->parent ) {
 					$category = get_category_parents( $category_object->parent, false, '/', true ) . $category;
 				}
 			}
-			// show default category in permalinks, without
+			// Show default category in permalinks,
-			// having to assign it explicitly
+			// without having to assign it explicitly.
 			if ( empty( $category ) ) {
 				$default_category = get_term( get_option( 'default_category' ), 'category' );
 				if ( $default_category && ! is_wp_error( $default_category ) ) {
 					$category = $default_category->slug;
 				}
 		if ( strpos( $permalink, '%author%' ) !== false ) {
 			$authordata = get_userdata( $post->post_author );
 			$author     = $authordata->user_nicename;
 		}
-		$date           = explode( ' ', date( 'Y m d H i s', $unixtime ) );
+		// This is not an API call because the permalink is based on the stored post_date value,
-		$rewritereplace =
+		// which should be parsed as local time regardless of the default PHP timezone.
-		array(
+		$date = explode( ' ', str_replace( array( '-', ':' ), ' ', $post->post_date ) );
+		$rewritereplace = array(
 			$date[0],
 			$date[1],
 			$date[2],
 			$date[3],
 			$date[4],
 			$post->ID,
 			$category,
 			$author,
 			$post->post_name,
 		);
-		$permalink      = home_url( str_replace( $rewritecode, $rewritereplace, $permalink ) );
-		$permalink      = user_trailingslashit( $permalink, 'single' );
+		$permalink = home_url( str_replace( $rewritecode, $rewritereplace, $permalink ) );
-	} else { // if they're not using the fancy permalink option
+		$permalink = user_trailingslashit( $permalink, 'single' );
+	} else { // If they're not using the fancy permalink option.
 		$permalink = home_url( '?p=' . $post->ID );
 	}
 	/**
 	 * Filters the permalink for a post.
 /**
 * Retrieves the permalink for a post of a custom post type.
 *
 * @since 3.0.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int|WP_Post $id        Optional. Post ID or post object. Default is the global `$post`.
-* @param bool        $leavename Optional, defaults to false. Whether to keep post name. Default false.
+* @param bool        $leavename Optional. Whether to keep post name. Default false.
-* @param bool        $sample    Optional, defaults to false. Is it a sample permalink. Default false.
+* @param bool        $sample    Optional. Is it a sample permalink. Default false.
 * @return string|WP_Error The post permalink.
 */
 function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
 	global $wp_rewrite;
 	$post_link = $wp_rewrite->get_extra_permastruct( $post->post_type );
 	$slug = $post->post_name;
-	$draft_or_pending = get_post_status( $post ) && in_array( get_post_status( $post ), array( 'draft', 'pending', 'auto-draft', 'future' ) );
+	$draft_or_pending = get_post_status( $post ) && in_array( get_post_status( $post ), array( 'draft', 'pending', 'auto-draft', 'future' ), true );
 	$post_type = get_post_type_object( $post->post_type );
 	if ( $post_type->hierarchical ) {
 		$slug = get_page_uri( $post );
 * @return string The page permalink.
 */
 function get_page_link( $post = false, $leavename = false, $sample = false ) {
 	$post = get_post( $post );
-	if ( 'page' == get_option( 'show_on_front' ) && $post->ID == get_option( 'page_on_front' ) ) {
+	if ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $post->ID ) {
 		$link = home_url( '/' );
 	} else {
 		$link = _get_page_link( $post, $leavename, $sample );
 	}
 * Ignores page_on_front. Internal use only.
 *
 * @since 2.1.0
 * @access private
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int|WP_Post $post      Optional. Post ID or object. Default uses the global `$post`.
 * @param bool        $leavename Optional. Whether to keep the page name. Default false.
 * @param bool        $sample    Optional. Whether it should be treated as a sample permalink.
 *                               Default false.
 function _get_page_link( $post = false, $leavename = false, $sample = false ) {
 	global $wp_rewrite;
 	$post = get_post( $post );
-	$draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
+	$draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ), true );
 	$link = $wp_rewrite->get_page_permastruct();
 	if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $draft_or_pending ) || $sample ) ) {
 		if ( ! $leavename ) {
 *
 * This can be used in the WordPress Loop or outside of it.
 *
 * @since 2.0.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int|object $post      Optional. Post ID or object. Default uses the global `$post`.
 * @param bool       $leavename Optional. Whether to keep the page name. Default false.
 * @return string The attachment permalink.
 */
 	$link = false;
 	$post   = get_post( $post );
 	$parent = ( $post->post_parent > 0 && $post->post_parent != $post->ID ) ? get_post( $post->post_parent ) : false;
-	if ( $parent && ! in_array( $parent->post_type, get_post_types() ) ) {
+	if ( $parent && ! in_array( $parent->post_type, get_post_types(), true ) ) {
 		$parent = false;
 	}
 	if ( $wp_rewrite->using_permalinks() && $parent ) {
-		if ( 'page' == $parent->post_type ) {
+		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 );
 		}
 		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;
 		}
 		if ( strpos( $parentlink, '?' ) === false ) {
 /**
 * Retrieves the permalink for the year archives.
 *
 * @since 1.5.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
-* @param int|bool $year False for current year or year for permalink.
+* @param int|false $year Integer of year. False for current year.
 * @return string The permalink for the specified year archive.
 */
 function get_year_link( $year ) {
 	global $wp_rewrite;
 	if ( ! $year ) {
 /**
 * Retrieves the permalink for the month archives with year.
 *
 * @since 1.0.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
-* @param bool|int $year  False for current year. Integer of year.
+* @param int|false $year  Integer of year. False for current year.
-* @param bool|int $month False for current month. Integer of month.
+* @param int|false $month Integer of month. False for current month.
 * @return string The permalink for the specified month and year archive.
 */
 function get_month_link( $year, $month ) {
 	global $wp_rewrite;
 	if ( ! $year ) {
 /**
 * Retrieves the permalink for the day archives with year and month.
 *
 * @since 1.0.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
-* @param bool|int $year  False for current year. Integer of year.
+* @param int|false $year  Integer of year. False for current year.
-* @param bool|int $month False for current month. Integer of month.
+* @param int|false $month Integer of month. False for current month.
-* @param bool|int $day   False for current day. Integer of day.
+* @param int|false $day   Integer of day. False for current day.
 * @return string The permalink for the specified day, month, and year archive.
 */
 function get_day_link( $year, $month, $day ) {
 	global $wp_rewrite;
 	if ( ! $year ) {
 * Displays the permalink for the feed type.
 *
 * @since 3.0.0
 *
 * @param string $anchor The link's anchor text.
-* @param string $feed   Optional. Feed type. Default empty.
+* @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                       Default is the value of get_default_feed().
 */
 function the_feed_link( $anchor, $feed = '' ) {
 	$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
 	/**
 	 * Filters the feed link anchor tag.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param string $link The complete anchor tag for a feed link.
-	 * @param string $feed The feed type, or an empty string for the
+	 * @param string $feed The feed type. Possible values include 'rss2', 'atom',
-	 *                     default feed type.
+	 *                     or an empty string for the default feed type.
 	 */
 	echo apply_filters( 'the_feed_link', $link, $feed );
 }
 /**
 * Retrieves the permalink for the feed type.
 *
 * @since 1.5.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
-* @param string $feed Optional. Feed type. Default empty.
+* @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                     Default is the value of get_default_feed().
 * @return string The feed permalink.
 */
 function get_feed_link( $feed = '' ) {
 	global $wp_rewrite;
 	$permalink = $wp_rewrite->get_feed_permastruct();
-	if ( '' != $permalink ) {
+	if ( '' !== $permalink ) {
 		if ( false !== strpos( $feed, 'comments_' ) ) {
 			$feed      = str_replace( 'comments_', '', $feed );
 			$permalink = $wp_rewrite->get_comment_feed_permastruct();
 		}
 	 * Filters the feed type permalink.
 	 *
 	 * @since 1.5.0
 	 *
 	 * @param string $output The feed permalink.
-	 * @param string $feed   Feed type.
+	 * @param string $feed   The feed type. Possible values include 'rss2', 'atom',
+	 *                       or an empty string for the default feed type.
 	 */
 	return apply_filters( 'feed_link', $output, $feed );
 }
 /**
 * Retrieves the permalink for the post comments feed.
 *
 * @since 2.2.0
 *
 * @param int    $post_id Optional. Post ID. Default is the ID of the global `$post`.
-* @param string $feed    Optional. Feed type. Default empty.
+* @param string $feed    Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                        Default is the value of get_default_feed().
 * @return string The permalink for the comments feed for the given post.
 */
 function get_post_comments_feed_link( $post_id = 0, $feed = '' ) {
 	$post_id = absint( $post_id );
 	}
 	$post       = get_post( $post_id );
 	$unattached = 'attachment' === $post->post_type && 0 === (int) $post->post_parent;
-	if ( '' != get_option( 'permalink_structure' ) ) {
+	if ( get_option( 'permalink_structure' ) ) {
-		if ( 'page' == get_option( 'show_on_front' ) && $post_id == get_option( 'page_on_front' ) ) {
+		if ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $post_id ) {
 			$url = _get_page_link( $post_id );
 		} else {
 			$url = get_permalink( $post_id );
 		}
 		if ( $unattached ) {
 			$url = home_url( '/feed/' );
-			if ( $feed !== get_default_feed() ) {
+			if ( get_default_feed() !== $feed ) {
 				$url .= "$feed/";
 			}
 			$url = add_query_arg( 'attachment_id', $post_id, $url );
 		} else {
 			$url = trailingslashit( $url ) . 'feed';
-			if ( $feed != get_default_feed() ) {
+			if ( get_default_feed() != $feed ) {
 				$url .= "/$feed";
 			}
 			$url = user_trailingslashit( $url, 'single_feed' );
 		}
 	} else {
 					'feed'          => $feed,
 					'attachment_id' => $post_id,
 				),
 				home_url( '/' )
 			);
-		} elseif ( 'page' == $post->post_type ) {
+		} elseif ( 'page' === $post->post_type ) {
 			$url = add_query_arg(
 				array(
 					'feed'    => $feed,
 					'page_id' => $post_id,
 				),
 *
 * @since 2.5.0
 *
 * @param string $link_text Optional. Descriptive link text. Default 'Comments Feed'.
 * @param int    $post_id   Optional. Post ID. Default is the ID of the global `$post`.
-* @param string $feed      Optional. Feed format. Default empty.
+* @param string $feed      Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                          Default is the value of get_default_feed().
 */
 function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
 	$url = get_post_comments_feed_link( $post_id, $feed );
 	if ( empty( $link_text ) ) {
 		$link_text = __( 'Comments Feed' );
 	 *
 	 * @since 2.8.0
 	 *
 	 * @param string $link    The complete anchor tag for the comment feed link.
 	 * @param int    $post_id Post ID.
-	 * @param string $feed    The feed type, or an empty string for the default feed type.
+	 * @param string $feed    The feed type. Possible values include 'rss2', 'atom',
+	 *                        or an empty string for the default feed type.
 	 */
 	echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed );
 }
 /**
 * can be requested or left blank to get the default feed.
 *
 * @since 2.5.0
 *
 * @param int    $author_id Author ID.
-* @param string $feed      Optional. Feed type. Default empty.
+* @param string $feed      Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                          Default is the value of get_default_feed().
 * @return string Link to the feed for the author specified by $author_id.
 */
 function get_author_feed_link( $author_id, $feed = '' ) {
 	$author_id           = (int) $author_id;
 	$permalink_structure = get_option( 'permalink_structure' );
 	if ( empty( $feed ) ) {
 		$feed = get_default_feed();
 	}
-	if ( '' == $permalink_structure ) {
+	if ( ! $permalink_structure ) {
 		$link = home_url( "?feed=$feed&amp;author=" . $author_id );
 	} else {
 		$link = get_author_posts_url( $author_id );
-		if ( $feed == get_default_feed() ) {
+		if ( get_default_feed() == $feed ) {
 			$feed_link = 'feed';
 		} else {
 			$feed_link = "feed/$feed";
 		}
 	 * Filters the feed link for a given author.
 	 *
 	 * @since 1.5.1
 	 *
 	 * @param string $link The author feed link.
-	 * @param string $feed Feed type.
+	 * @param string $feed Feed type. Possible values include 'rss2', 'atom'.
 	 */
 	$link = apply_filters( 'author_feed_link', $link, $feed );
 	return $link;
 }
 * can be requested or left blank to get the default feed.
 *
 * @since 2.5.0
 *
 * @param int    $cat_id Category ID.
-* @param string $feed   Optional. Feed type. Default empty.
+* @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                       Default is the value of get_default_feed().
 * @return string Link to the feed for the category specified by $cat_id.
 */
 function get_category_feed_link( $cat_id, $feed = '' ) {
 	return get_term_feed_link( $cat_id, 'category', $feed );
 }
 *
 * @since 3.0.0
 *
 * @param int    $term_id  Term ID.
 * @param string $taxonomy Optional. Taxonomy of `$term_id`. Default 'category'.
-* @param string $feed     Optional. Feed type. Default empty.
+* @param string $feed     Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                         Default is the value of get_default_feed().
 * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
 */
 function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
 	$term_id = (int) $term_id;
 		$feed = get_default_feed();
 	}
 	$permalink_structure = get_option( 'permalink_structure' );
-	if ( '' == $permalink_structure ) {
+	if ( ! $permalink_structure ) {
-		if ( 'category' == $taxonomy ) {
+		if ( 'category' === $taxonomy ) {
 			$link = home_url( "?feed=$feed&amp;cat=$term_id" );
-		} elseif ( 'post_tag' == $taxonomy ) {
+		} elseif ( 'post_tag' === $taxonomy ) {
 			$link = home_url( "?feed=$feed&amp;tag=$term->slug" );
 		} else {
 			$t    = get_taxonomy( $taxonomy );
 			$link = home_url( "?feed=$feed&amp;$t->query_var=$term->slug" );
 		}
 	} else {
 		$link = get_term_link( $term_id, $term->taxonomy );
-		if ( $feed == get_default_feed() ) {
+		if ( get_default_feed() == $feed ) {
 			$feed_link = 'feed';
 		} else {
 			$feed_link = "feed/$feed";
 		}
 		$link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' );
 	}
-	if ( 'category' == $taxonomy ) {
+	if ( 'category' === $taxonomy ) {
 		/**
 		 * Filters the category feed link.
 		 *
 		 * @since 1.5.1
 		 *
 		 * @param string $link The category feed link.
-		 * @param string $feed Feed type.
+		 * @param string $feed Feed type. Possible values include 'rss2', 'atom'.
 		 */
 		$link = apply_filters( 'category_feed_link', $link, $feed );
-	} elseif ( 'post_tag' == $taxonomy ) {
+	} elseif ( 'post_tag' === $taxonomy ) {
 		/**
 		 * Filters the post tag feed link.
 		 *
 		 * @since 2.3.0
 		 *
 		 * @param string $link The tag feed link.
-		 * @param string $feed Feed type.
+		 * @param string $feed Feed type. Possible values include 'rss2', 'atom'.
 		 */
 		$link = apply_filters( 'tag_feed_link', $link, $feed );
 	} else {
 		/**
 		 * Filters the feed link for a taxonomy other than 'category' or 'post_tag'.
 		 *
 		 * @since 3.0.0
 		 *
-		 * @param string $link The taxonomy feed link.
+		 * @param string $link     The taxonomy feed link.
-		 * @param string $feed Feed type.
+		 * @param string $feed     Feed type. Possible values include 'rss2', 'atom'.
 		 * @param string $taxonomy The taxonomy name.
 		 */
 		$link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
 	}
 * Retrieves the permalink for a tag feed.
 *
 * @since 2.3.0
 *
 * @param int    $tag_id Tag ID.
-* @param string $feed   Optional. Feed type. Default empty.
+* @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                       Default is the value of get_default_feed().
 * @return string The feed permalink for the given tag.
 */
 function get_tag_feed_link( $tag_id, $feed = '' ) {
 	return get_term_feed_link( $tag_id, 'post_tag', $feed );
 }
 /**
 * Displays or retrieves the edit link for a tag with formatting.
 *
 * @since 2.7.0
 *
-* @param string  $link   Optional. Anchor text. Default empty.
+* @param string  $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
 * @param string  $before Optional. Display before edit link. Default empty.
 * @param string  $after  Optional. Display after edit link. Default empty.
 * @param WP_Term $tag    Optional. Term object. If null, the queried object will be inspected.
 *                        Default null.
 */
 /**
 * Retrieves the URL for editing a given term.
 *
 * @since 3.1.0
-* @since 4.5.0 The `$taxonomy` argument was made optional.
+* @since 4.5.0 The `$taxonomy` parameter was made optional.
 *
 * @param int    $term_id     Term ID.
 * @param string $taxonomy    Optional. Taxonomy. Defaults to the taxonomy of the term identified
 *                            by `$term_id`.
 * @param string $object_type Optional. The object type. Used to highlight the proper post type
 /**
 * Displays or retrieves the edit term link with formatting.
 *
 * @since 3.1.0
 *
-* @param string $link   Optional. Anchor text. Default empty.
+* @param string  $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
-* @param string $before Optional. Display before edit link. Default empty.
+* @param string  $before Optional. Display before edit link. Default empty.
-* @param string $after  Optional. Display after edit link. Default empty.
+* @param string  $after  Optional. Display after edit link. Default empty.
-* @param object $term   Optional. Term object. If null, the queried object will be inspected. Default null.
+* @param WP_Term $term   Optional. Term object. If null, the queried object will be inspected. Default null.
-* @param bool   $echo   Optional. Whether or not to echo the return. Default true.
+* @param bool    $echo   Optional. Whether or not to echo the return. Default true.
 * @return string|void HTML content.
 */
 function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
 	if ( is_null( $term ) ) {
 		$term = get_queried_object();
 }
 /**
 * Retrieves the permalink for a search.
 *
-* @since  3.0.0
+* @since 3.0.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string $query Optional. The query string to use. If empty the current query is used. Default empty.
 * @return string The search permalink.
 */
 function get_search_link( $query = '' ) {
 /**
 * Retrieves the permalink for the search results feed.
 *
 * @since 2.5.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string $search_query Optional. Search query. Default empty.
-* @param string $feed         Optional. Feed type. Default empty.
+* @param string $feed         Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                             Default is the value of get_default_feed().
 * @return string The search results feed permalink.
 */
 function get_search_feed_link( $search_query = '', $feed = '' ) {
 	global $wp_rewrite;
 	$link = get_search_link( $search_query );
 	 * Filters the search feed link.
 	 *
 	 * @since 2.5.0
 	 *
 	 * @param string $link Search feed link.
-	 * @param string $feed Feed type.
+	 * @param string $feed Feed type. Possible values include 'rss2', 'atom'.
 	 * @param string $type The search type. One of 'posts' or 'comments'.
 	 */
 	return apply_filters( 'search_feed_link', $link, $feed, 'posts' );
 }
 /**
 * Retrieves the permalink for the search results comments feed.
 *
 * @since 2.5.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string $search_query Optional. Search query. Default empty.
-* @param string $feed         Optional. Feed type. Default empty.
+* @param string $feed         Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                             Default is the value of get_default_feed().
 * @return string The comments feed search results permalink.
 */
 function get_search_comments_feed_link( $search_query = '', $feed = '' ) {
 	global $wp_rewrite;
 * Retrieves the permalink for a post type archive.
 *
 * @since 3.1.0
 * @since 4.5.0 Support for posts was added.
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string $post_type Post type.
 * @return string|false The post type archive permalink.
 */
 function get_post_type_archive_link( $post_type ) {
 	global $wp_rewrite;
-	if ( ! $post_type_obj = get_post_type_object( $post_type ) ) {
+	$post_type_obj = get_post_type_object( $post_type );
+	if ( ! $post_type_obj ) {
 		return false;
 	}
 	if ( 'post' === $post_type ) {
 		$show_on_front  = get_option( 'show_on_front' );
 		$page_for_posts = get_option( 'page_for_posts' );
-		if ( 'page' == $show_on_front && $page_for_posts ) {
+		if ( 'page' === $show_on_front && $page_for_posts ) {
 			$link = get_permalink( $page_for_posts );
 		} else {
 			$link = get_home_url();
 		}
 		/** This filter is documented in wp-includes/link-template.php */
 * Retrieves the permalink for a post type archive feed.
 *
 * @since 3.1.0
 *
 * @param string $post_type Post type
-* @param string $feed      Optional. Feed type. Default empty.
+* @param string $feed      Optional. Feed type. Possible values include 'rss2', 'atom'.
+*                          Default is the value of get_default_feed().
 * @return string|false The post type feed permalink.
 */
 function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
 	$default_feed = get_default_feed();
 	if ( empty( $feed ) ) {
 		$feed = $default_feed;
 	}
-	if ( ! $link = get_post_type_archive_link( $post_type ) ) {
+	$link = get_post_type_archive_link( $post_type );
+	if ( ! $link ) {
 		return false;
 	}
 	$post_type_obj = get_post_type_object( $post_type );
 	if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) {
 	 * Filters the post type archive feed link.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @param string $link The post type archive feed link.
-	 * @param string $feed Feed type.
+	 * @param string $feed Feed type. Possible values include 'rss2', 'atom'.
 	 */
 	return apply_filters( 'post_type_archive_feed_link', $link, $feed );
 }
 /**
 * @param string      $context Optional. How to output the '&' character. Default '&amp;'.
 * @return string|null The edit post link for the given post. null if the post type is invalid or does
 *                     not allow an editing UI.
 */
 function get_edit_post_link( $id = 0, $context = 'display' ) {
-	if ( ! $post = get_post( $id ) ) {
+	$post = get_post( $id );
+	if ( ! $post ) {
 		return;
 	}
 	if ( 'revision' === $post->post_type ) {
 		$action = '';
-	} elseif ( 'display' == $context ) {
+	} elseif ( 'display' === $context ) {
 		$action = '&amp;action=edit';
 	} else {
 		$action = '&action=edit';
 	}
 * @param string      $after  Optional. Display after edit link. Default empty.
 * @param int|WP_Post $id     Optional. Post ID or post object. Default is the global `$post`.
 * @param string      $class  Optional. Add custom class to link. Default 'post-edit-link'.
 */
 function edit_post_link( $text = null, $before = '', $after = '', $id = 0, $class = 'post-edit-link' ) {
-	if ( ! $post = get_post( $id ) ) {
+	$post = get_post( $id );
+	if ( ! $post ) {
 		return;
 	}
-	if ( ! $url = get_edit_post_link( $post->ID ) ) {
+	$url = get_edit_post_link( $post->ID );
+	if ( ! $url ) {
 		return;
 	}
 	if ( null === $text ) {
 		$text = __( 'Edit This' );
 *
 * @since 2.9.0
 *
 * @param int|WP_Post $id           Optional. Post ID or post object. Default is the global `$post`.
 * @param string      $deprecated   Not used.
-* @param bool        $force_delete Optional. Whether to bypass trash and force deletion. Default false.
+* @param bool        $force_delete Optional. Whether to bypass Trash and force deletion. Default false.
 * @return string|void The delete post link URL for the given post.
 */
 function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
 	if ( ! empty( $deprecated ) ) {
 		_deprecated_argument( __FUNCTION__, '3.0.0' );
 	}
-	if ( ! $post = get_post( $id ) ) {
+	$post = get_post( $id );
+	if ( ! $post ) {
 		return;
 	}
 	$post_type_object = get_post_type_object( $post->post_type );
 	if ( ! $post_type_object ) {
 	 *
 	 * @since 2.9.0
 	 *
 	 * @param string $link         The delete link.
 	 * @param int    $post_id      Post ID.
-	 * @param bool   $force_delete Whether to bypass the trash and force deletion. Default false.
+	 * @param bool   $force_delete Whether to bypass the Trash and force deletion. Default false.
 	 */
 	return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete );
 }
 /**
 /**
 * Displays the edit bookmark link.
 *
 * @since 2.7.0
 *
-* @param int|stdClass $link Optional. Bookmark ID. Default is the id of the current bookmark.
+* @param int|stdClass $link Optional. Bookmark ID. Default is the ID of the current bookmark.
 * @return string|void The edit bookmark link URL.
 */
 function get_edit_bookmark_link( $link = 0 ) {
 	$link = get_bookmark( $link );
 /**
 * Displays the edit bookmark link anchor content.
 *
 * @since 2.7.0
 *
-* @param string $link     Optional. Anchor text. Default empty.
+* @param string $link     Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
 * @param string $before   Optional. Display before edit link. Default empty.
 * @param string $after    Optional. Display after edit link. Default empty.
 * @param int    $bookmark Optional. Bookmark ID. Default is the current bookmark.
 */
 function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
 	 * @param int    $user_id User ID.
 	 */
 	return apply_filters( 'get_edit_user_link', $link, $user->ID );
 }
-// Navigation links
+//
+// Navigation links.
+//
 /**
 * Retrieves the previous post that is adjacent to the current post.
 *
 * @since 1.5.0
 *                             corresponding post exists.
 */
 function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
 	global $wpdb;
-	if ( ( ! $post = get_post() ) || ! taxonomy_exists( $taxonomy ) ) {
+	$post = get_post();
+	if ( ! $post || ! taxonomy_exists( $taxonomy ) ) {
 		return null;
 	}
 	$current_post_date = $post->post_date;
 	$adjacent = $previous ? 'previous' : 'next';
 	if ( ! empty( $excluded_terms ) && ! is_array( $excluded_terms ) ) {
 		// Back-compat, $excluded_terms used to be $excluded_categories with IDs separated by " and ".
 		if ( false !== strpos( $excluded_terms, ' and ' ) ) {
-			_deprecated_argument( __FUNCTION__, '3.3.0', sprintf( __( 'Use commas instead of %s to separate excluded terms.' ), "'and'" ) );
+			_deprecated_argument(
+				__FUNCTION__,
+				'3.3.0',
+				sprintf(
+					/* translators: %s: The word 'and'. */
+					__( 'Use commas instead of %s to separate excluded terms.' ),
+					"'and'"
+				)
+			);
 			$excluded_terms = explode( ' and ', $excluded_terms );
 		} else {
 			$excluded_terms = explode( ',', $excluded_terms );
 		}
 * @param bool         $previous       Optional. Whether to display link to previous or next post. Default true.
 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
 * @return string|void The adjacent post relational link URL.
 */
 function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
-	if ( $previous && is_attachment() && $post = get_post() ) {
+	$post = get_post();
+	if ( $previous && is_attachment() && $post ) {
 		$post = get_post( $post->post_parent );
 	} else {
 		$post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy );
 	}
 /**
 * Displays the next post link that is adjacent to the current post.
 *
 * @since 1.5.0
+*
 * @see get_next_post_link()
 *
 * @param string       $format         Optional. Link anchor format. Default '&laquo; %link'.
 * @param string       $link           Optional. Link permalink format. Default '%title'
 * @param bool         $in_same_term   Optional. Whether link should be in a same taxonomy term. Default false.
 /**
 * Retrieves the link for a page number.
 *
 * @since 1.5.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int  $pagenum Optional. Page number. Default 1.
 * @param bool $escape  Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
 *                      Otherwise, prepares the URL with esc_url_raw().
 * @return string The link URL for the given page number.
 		$request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request );
 		$request = ltrim( $request, '/' );
 		$base = trailingslashit( get_bloginfo( 'url' ) );
-		if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' != $request ) ) {
+		if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) {
 			$base .= $wp_rewrite->index . '/';
 		}
 		if ( $pagenum > 1 ) {
 			$request = ( ( ! empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . '/' . $pagenum, 'paged' );
 /**
 * Displays or retrieves the next posts page link.
 *
 * @since 0.71
 *
-* @param int   $max_page Optional. Max pages. Default 0.
+* @param int  $max_page Optional. Max pages. Default 0.
-* @param bool  $echo     Optional. Whether to echo the link. Default true.
+* @param bool $echo     Optional. Whether to echo the link. Default true.
 * @return string|void The link URL for next posts page if `$echo = false`.
 */
 function next_posts( $max_page = 0, $echo = true ) {
 	$output = esc_url( get_next_posts_page_link( $max_page ) );
 * Retrieves the next posts page link.
 *
 * @since 2.7.0
 *
 * @global int      $paged
-* @global WP_Query $wp_query
+* @global WP_Query $wp_query WordPress Query object.
 *
 * @param string $label    Content for link text.
 * @param int    $max_page Optional. Max pages. Default 0.
 * @return string|void HTML-formatted next posts page link.
 */
 /**
 * Retrieves the post pages link navigation for previous and next pages.
 *
 * @since 2.8.0
 *
-* @global WP_Query $wp_query
+* @global WP_Query $wp_query WordPress Query object.
 *
 * @param string|array $args {
 *     Optional. Arguments to build the post pages link navigation.
 *
 *     @type string $sep      Separator character. Default '&#8212;'.
 		$args     = wp_parse_args( $args, $defaults );
 		$max_num_pages = $wp_query->max_num_pages;
 		$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'] = '';
 		}
 		if ( $max_num_pages > 1 ) {
 /**
 * Retrieves the navigation to next/previous post, when applicable.
 *
 * @since 4.1.0
 * @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments.
+* @since 5.3.0 Added the `aria_label` parameter.
+* @since 5.5.0 Added the `class` parameter.
 *
 * @param array $args {
 *     Optional. Default post navigation arguments. Default empty array.
 *
 *     @type string       $prev_text          Anchor text to display in the previous post link. Default '%title'.
 *     @type string       $next_text          Anchor text to display in the next post link. Default '%title'.
 *     @type bool         $in_same_term       Whether link should be in a same taxonomy term. Default false.
 *     @type array|string $excluded_terms     Array or comma-separated list of excluded term IDs. Default empty.
 *     @type string       $taxonomy           Taxonomy, if `$in_same_term` is true. Default 'category'.
-*     @type string       $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
+*     @type string       $screen_reader_text Screen reader text for the nav element. Default 'Post navigation'.
+*     @type string       $aria_label         ARIA label text for the nav element. Default 'Posts'.
+*     @type string       $class              Custom class for the nav element. Default 'post-navigation'.
 * }
 * @return string Markup for post links.
 */
 function get_the_post_navigation( $args = array() ) {
+	// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+	if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+		$args['aria_label'] = $args['screen_reader_text'];
+	}
 	$args = wp_parse_args(
 		$args,
 		array(
 			'prev_text'          => '%title',
 			'next_text'          => '%title',
 			'in_same_term'       => false,
 			'excluded_terms'     => '',
 			'taxonomy'           => 'category',
 			'screen_reader_text' => __( 'Post navigation' ),
+			'aria_label'         => __( 'Posts' ),
+			'class'              => 'post-navigation',
 		)
 	);
 	$navigation = '';
 		$args['taxonomy']
 	);
 	// Only add markup if there's somewhere to navigate to.
 	if ( $previous || $next ) {
-		$navigation = _navigation_markup( $previous . $next, 'post-navigation', $args['screen_reader_text'] );
+		$navigation = _navigation_markup( $previous . $next, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
 	}
 	return $navigation;
 }
 /**
 * Returns the navigation to next/previous set of posts, when applicable.
 *
 * @since 4.1.0
+* @since 5.3.0 Added the `aria_label` parameter.
+* @since 5.5.0 Added the `class` parameter.
 *
 * @global WP_Query $wp_query WordPress Query object.
 *
 * @param array $args {
 *     Optional. Default posts navigation arguments. Default empty array.
 *
 *     @type string $prev_text          Anchor text to display in the previous posts link.
 *                                      Default 'Older posts'.
 *     @type string $next_text          Anchor text to display in the next posts link.
 *                                      Default 'Newer posts'.
-*     @type string $screen_reader_text Screen reader text for nav element.
+*     @type string $screen_reader_text Screen reader text for the nav element.
 *                                      Default 'Posts navigation'.
+*     @type string $aria_label         ARIA label text for the nav element. Default 'Posts'.
+*     @type string $class              Custom class for the nav element. Default 'posts-navigation'.
 * }
 * @return string Markup for posts links.
 */
 function get_the_posts_navigation( $args = array() ) {
 	$navigation = '';
 	// Don't print empty markup if there's only one page.
 	if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+			$args['aria_label'] = $args['screen_reader_text'];
+		}
 		$args = wp_parse_args(
 			$args,
 			array(
 				'prev_text'          => __( 'Older posts' ),
 				'next_text'          => __( 'Newer posts' ),
 				'screen_reader_text' => __( 'Posts navigation' ),
+				'aria_label'         => __( 'Posts' ),
+				'class'              => 'posts-navigation',
 			)
 		);
 		$next_link = get_previous_posts_link( $args['next_text'] );
 		$prev_link = get_next_posts_link( $args['prev_text'] );
 		if ( $next_link ) {
 			$navigation .= '<div class="nav-next">' . $next_link . '</div>';
 		}
-		$navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] );
+		$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
 	}
 	return $navigation;
 }
 /**
 * Retrieves a paginated navigation to next/previous set of posts, when applicable.
 *
 * @since 4.1.0
+* @since 5.3.0 Added the `aria_label` parameter.
+* @since 5.5.0 Added the `class` parameter.
 *
 * @param array $args {
 *     Optional. Default pagination arguments, see paginate_links().
 *
 *     @type string $screen_reader_text Screen reader text for navigation element.
 *                                      Default 'Posts navigation'.
+*     @type string $aria_label         ARIA label text for the nav element. Default 'Posts'.
+*     @type string $class              Custom class for the nav element. Default 'pagination'.
 * }
 * @return string Markup for pagination links.
 */
 function get_the_posts_pagination( $args = array() ) {
 	$navigation = '';
 	// Don't print empty markup if there's only one page.
 	if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+			$args['aria_label'] = $args['screen_reader_text'];
+		}
 		$args = wp_parse_args(
 			$args,
 			array(
 				'mid_size'           => 1,
 				'prev_text'          => _x( 'Previous', 'previous set of posts' ),
 				'next_text'          => _x( 'Next', 'next set of posts' ),
 				'screen_reader_text' => __( 'Posts navigation' ),
+				'aria_label'         => __( 'Posts' ),
+				'class'              => 'pagination',
 			)
 		);
 		// Make sure we get a string back. Plain is the next best thing.
-		if ( isset( $args['type'] ) && 'array' == $args['type'] ) {
+		if ( isset( $args['type'] ) && 'array' === $args['type'] ) {
 			$args['type'] = 'plain';
 		}
 		// Set up paginated links.
 		$links = paginate_links( $args );
 		if ( $links ) {
-			$navigation = _navigation_markup( $links, 'pagination', $args['screen_reader_text'] );
+			$navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
 		}
 	}
 	return $navigation;
 }
 /**
 * Wraps passed links in navigational markup.
 *
 * @since 4.1.0
+* @since 5.3.0 Added the `aria_label` parameter.
 * @access private
 *
 * @param string $links              Navigational links.
-* @param string $class              Optional. Custom class for nav element. Default: 'posts-navigation'.
+* @param string $class              Optional. Custom class for the nav element.
-* @param string $screen_reader_text Optional. Screen reader text for nav element. Default: 'Posts navigation'.
+*                                   Default 'posts-navigation'.
+* @param string $screen_reader_text Optional. Screen reader text for the nav element.
+*                                   Default 'Posts navigation'.
+* @param string $aria_label         Optional. ARIA label for the nav element.
+*                                   Defaults to the value of `$screen_reader_text`.
 * @return string Navigation template tag.
 */
-function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) {
+function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) {
 	if ( empty( $screen_reader_text ) ) {
 		$screen_reader_text = __( 'Posts navigation' );
 	}
+	if ( empty( $aria_label ) ) {
+		$aria_label = $screen_reader_text;
+	}
 	$template = '
-	<nav class="navigation %1$s" role="navigation">
+	<nav class="navigation %1$s" role="navigation" aria-label="%4$s">
 		<h2 class="screen-reader-text">%2$s</h2>
 		<div class="nav-links">%3$s</div>
 	</nav>';
 	/**
 	 * Filters the navigation markup template.
 	 *
 	 * Note: The filtered template HTML must contain specifiers for the navigation
-	 * class (%1$s), the screen-reader-text value (%2$s), and placement of the
+	 * class (%1$s), the screen-reader-text value (%2$s), placement of the navigation
-	 * navigation links (%3$s):
+	 * links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s):
 	 *
-	 *     <nav class="navigation %1$s" role="navigation">
+	 *     <nav class="navigation %1$s" role="navigation" aria-label="%4$s">
 	 *         <h2 class="screen-reader-text">%2$s</h2>
 	 *         <div class="nav-links">%3$s</div>
 	 *     </nav>
 	 *
 	 * @since 4.4.0
 	 * @param string $class    The class passed by the calling function.
 	 * @return string Navigation template.
 	 */
 	$template = apply_filters( 'navigation_markup_template', $template, $class );
-	return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
+	return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links, esc_html( $aria_label ) );
 }
 /**
 * Retrieves the comments page number link.
 *
 * @since 2.7.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int $pagenum  Optional. Page number. Default 1.
 * @param int $max_page Optional. The maximum number of comment pages. Default 0.
 * @return string The comments page number link URL.
 */
 	$pagenum = (int) $pagenum;
 	$result = get_permalink();
-	if ( 'newest' == get_option( 'default_comments_page' ) ) {
+	if ( 'newest' === get_option( 'default_comments_page' ) ) {
 		if ( $pagenum != $max_page ) {
 			if ( $wp_rewrite->using_permalinks() ) {
 				$result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' );
 			} else {
 				$result = add_query_arg( 'cpage', $pagenum, $result );
 /**
 * Retrieves the link to the next comments page.
 *
 * @since 2.7.1
 *
-* @global WP_Query $wp_query
+* @global WP_Query $wp_query WordPress Query object.
 *
 * @param string $label    Optional. Label for link text. Default empty.
 * @param int    $max_page Optional. Max page. Default 0.
 * @return string|void HTML-formatted link for the next page of comments.
 */
 * Displays or retrieves pagination links for the comments on the current post.
 *
 * @see paginate_links()
 * @since 2.7.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param string|array $args Optional args. See paginate_links(). Default empty array.
-* @return string|array|void Markup for comment page links or array of comment page links.
+* @return void|string|array Void if 'echo' argument is true and 'type' is not an array,
+*                           or if the query is not for an existing single post of any post type.
+*                           Otherwise, markup for comment page links or array of comment page links,
+*                           depending on 'type' argument.
 */
 function paginate_comments_links( $args = array() ) {
 	global $wp_rewrite;
 	if ( ! is_singular() ) {
 /**
 * Retrieves navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
+* @since 5.3.0 Added the `aria_label` parameter.
+* @since 5.5.0 Added the `class` parameter.
 *
 * @param array $args {
 *     Optional. Default comments navigation arguments.
 *
 *     @type string $prev_text          Anchor text to display in the previous comments link.
 *                                      Default 'Older comments'.
 *     @type string $next_text          Anchor text to display in the next comments link.
 *                                      Default 'Newer comments'.
-*     @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
+*     @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'.
+*     @type string $aria_label         ARIA label text for the nav element. Default 'Comments'.
+*     @type string $class              Custom class for the nav element. Default 'comment-navigation'.
 * }
 * @return string Markup for comments links.
 */
 function get_the_comments_navigation( $args = array() ) {
 	$navigation = '';
 	// Are there comments to navigate through?
 	if ( get_comment_pages_count() > 1 ) {
+		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+			$args['aria_label'] = $args['screen_reader_text'];
+		}
 		$args = wp_parse_args(
 			$args,
 			array(
 				'prev_text'          => __( 'Older comments' ),
 				'next_text'          => __( 'Newer comments' ),
 				'screen_reader_text' => __( 'Comments navigation' ),
+				'aria_label'         => __( 'Comments' ),
+				'class'              => 'comment-navigation',
 			)
 		);
 		$prev_link = get_previous_comments_link( $args['prev_text'] );
 		$next_link = get_next_comments_link( $args['next_text'] );
 		if ( $next_link ) {
 			$navigation .= '<div class="nav-next">' . $next_link . '</div>';
 		}
-		$navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'] );
+		$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
 	}
 	return $navigation;
 }
 /**
 * Retrieves a paginated navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
+* @since 5.3.0 Added the `aria_label` parameter.
+* @since 5.5.0 Added the `class` parameter.
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
-*     @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
+*     @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'.
+*     @type string $aria_label         ARIA label text for the nav element. Default 'Comments'.
+*     @type string $class              Custom class for the nav element. Default 'comments-pagination'.
 * }
 * @return string Markup for pagination links.
 */
 function get_the_comments_pagination( $args = array() ) {
-	$navigation   = '';
+	$navigation = '';
+	// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+	if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+		$args['aria_label'] = $args['screen_reader_text'];
+	}
 	$args         = wp_parse_args(
 		$args,
 		array(
 			'screen_reader_text' => __( 'Comments navigation' ),
+			'aria_label'         => __( 'Comments' ),
+			'class'              => 'comments-pagination',
 		)
 	);
 	$args['echo'] = false;
 	// Make sure we get a string back. Plain is the next best thing.
-	if ( isset( $args['type'] ) && 'array' == $args['type'] ) {
+	if ( isset( $args['type'] ) && 'array' === $args['type'] ) {
 		$args['type'] = 'plain';
 	}
 	$links = paginate_comments_links( $args );
 	if ( $links ) {
-		$navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'] );
+		$navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
 	}
 	return $navigation;
 }
 * if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option.
 * If `$scheme` is 'http' or 'https', is_ssl() is overridden.
 *
 * @since 3.0.0
 *
-* @param  string      $path   Optional. Path relative to the home URL. Default empty.
+* @param string      $path   Optional. Path relative to the home URL. Default empty.
-* @param  string|null $scheme Optional. Scheme to give the home URL context. Accepts
+* @param string|null $scheme Optional. Scheme to give the home URL context. Accepts
-*                             'http', 'https', 'relative', 'rest', or null. Default null.
+*                            'http', 'https', 'relative', 'rest', or null. Default null.
 * @return string Home URL link with optional path appended.
 */
 function home_url( $path = '', $scheme = null ) {
 	return get_home_url( null, $path, $scheme );
 }
 *
 * @since 3.0.0
 *
 * @global string $pagenow
 *
-* @param  int         $blog_id Optional. Site ID. Default null (current site).
+* @param int         $blog_id Optional. Site ID. Default null (current site).
-* @param  string      $path    Optional. Path relative to the home URL. Default empty.
+* @param string      $path    Optional. Path relative to the home URL. Default empty.
-* @param  string|null $scheme  Optional. Scheme to give the home URL context. Accepts
+* @param string|null $scheme  Optional. Scheme to give the home URL context. Accepts
-*                              'http', 'https', 'relative', 'rest', or null. Default null.
+*                             'http', 'https', 'relative', 'rest', or null. Default null.
 * @return string Home URL link with optional path appended.
 */
 function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
 	global $pagenow;
 		switch_to_blog( $blog_id );
 		$url = get_option( 'home' );
 		restore_current_blog();
 	}
-	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
+	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
 		if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $pagenow ) {
 			$scheme = 'https';
 		} else {
 			$scheme = parse_url( $url, PHP_URL_SCHEME );
 		}
 *
 * Defaults to the plugins directory URL if no arguments are supplied.
 *
 * @since 2.6.0
 *
-* @param  string $path   Optional. Extra path appended to the end of the URL, including
+* @param string $path   Optional. Extra path appended to the end of the URL, including
-*                        the relative directory if $plugin is supplied. Default empty.
+*                       the relative directory if $plugin is supplied. Default empty.
-* @param  string $plugin Optional. A full path to a file inside a plugin or mu-plugin.
+* @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin.
-*                        The URL will be relative to its directory. Default empty.
+*                       The URL will be relative to its directory. Default empty.
-*                        Typically this is done by passing `__FILE__` as the argument.
+*                       Typically this is done by passing `__FILE__` as the argument.
 * @return string Plugins URL link with optional paths appended.
 */
 function plugins_url( $path = '', $plugin = '' ) {
 	$path          = wp_normalize_path( $path );
 	$url = set_url_scheme( $url );
 	if ( ! empty( $plugin ) && is_string( $plugin ) ) {
 		$folder = dirname( plugin_basename( $plugin ) );
-		if ( '.' != $folder ) {
+		if ( '.' !== $folder ) {
 			$url .= '/' . ltrim( $folder, '/' );
 		}
 	}
 	if ( $path && is_string( $path ) ) {
 		return site_url( $path, $scheme );
 	}
 	$current_network = get_network();
-	if ( 'relative' == $scheme ) {
+	if ( 'relative' === $scheme ) {
 		$url = $current_network->path;
 	} else {
 		$url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme );
 	}
 * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
 * overridden.
 *
 * @since 3.0.0
 *
-* @param  string $path   Optional. Path relative to the home URL. Default empty.
+* @param string $path   Optional. Path relative to the home URL. Default empty.
-* @param  string $scheme Optional. Scheme to give the home URL context. Accepts
+* @param string $scheme Optional. Scheme to give the home URL context. Accepts
-*                        'http', 'https', or 'relative'. Default null.
+*                       'http', 'https', or 'relative'. Default null.
 * @return string Home URL link with optional path appended.
 */
 function network_home_url( $path = '', $scheme = null ) {
 	if ( ! is_multisite() ) {
 		return home_url( $path, $scheme );
 	}
 	$current_network = get_network();
 	$orig_scheme     = $scheme;
-	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
+	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
 		$scheme = is_ssl() && ! is_admin() ? 'https' : 'http';
 	}
-	if ( 'relative' == $scheme ) {
+	if ( 'relative' === $scheme ) {
 		$url = $current_network->path;
 	} else {
 		$url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme );
 	}
 * @since 4.4.0 The 'rest' scheme was added.
 *
 * @param string      $url    Absolute URL that includes a scheme
 * @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login',
 *                            'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null.
-* @return string $url URL with chosen scheme.
+* @return string URL with chosen scheme.
 */
 function set_url_scheme( $url, $scheme = null ) {
 	$orig_scheme = $scheme;
 	if ( ! $scheme ) {
 		$scheme = is_ssl() ? 'https' : 'http';
-	} elseif ( $scheme === 'admin' || $scheme === 'login' || $scheme === 'login_post' || $scheme === 'rpc' ) {
+	} elseif ( 'admin' === $scheme || 'login' === $scheme || 'login_post' === $scheme || 'rpc' === $scheme ) {
 		$scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http';
-	} elseif ( $scheme !== 'http' && $scheme !== 'https' && $scheme !== 'relative' ) {
+	} elseif ( 'http' !== $scheme && 'https' !== $scheme && 'relative' !== $scheme ) {
 		$scheme = is_ssl() ? 'https' : 'http';
 	}
 	$url = trim( $url );
 	if ( substr( $url, 0, 2 ) === '//' ) {
 		$url = 'http:' . $url;
 	}
-	if ( 'relative' == $scheme ) {
+	if ( 'relative' === $scheme ) {
 		$url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) );
-		if ( $url !== '' && $url[0] === '/' ) {
+		if ( '' !== $url && '/' === $url[0] ) {
 			$url = '/' . ltrim( $url, "/ \t\n\r\0\x0B" );
 		}
 	} else {
 		$url = preg_replace( '#^\w+://#', $scheme . '://', $url );
 	}
 */
 function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
 	$user_id = $user_id ? (int) $user_id : get_current_user_id();
 	$blogs = get_blogs_of_user( $user_id );
 	if ( is_multisite() && ! user_can( $user_id, 'manage_network' ) && empty( $blogs ) ) {
 		$url = user_admin_url( $path, $scheme );
 	} elseif ( ! is_multisite() ) {
 		$url = admin_url( $path, $scheme );
 	} else {
 		$current_blog = get_current_blog_id();
-		if ( $current_blog && ( user_can( $user_id, 'manage_network' ) || in_array( $current_blog, array_keys( $blogs ) ) ) ) {
+		if ( $current_blog && ( user_can( $user_id, 'manage_network' ) || in_array( $current_blog, array_keys( $blogs ), true ) ) ) {
 			$url = admin_url( $path, $scheme );
 		} else {
 			$active = get_active_blog_for_user( $user_id );
 			if ( $active ) {
 				$url = get_admin_url( $active->blog_id, $path, $scheme );
 	}
 	$canonical_url = get_permalink( $post );
 	// If a canonical is being generated for the current page, make sure it has pagination if needed.
-	if ( $post->ID === get_queried_object_id() ) {
+	if ( get_queried_object_id() === $post->ID ) {
 		$page = get_query_var( 'page', 0 );
 		if ( $page >= 2 ) {
-			if ( '' == get_option( 'permalink_structure' ) ) {
+			if ( ! get_option( 'permalink_structure' ) ) {
 				$canonical_url = add_query_arg( 'page', $page, $canonical_url );
 			} else {
 				$canonical_url = trailingslashit( $canonical_url ) . user_trailingslashit( $page, 'single_paged' );
 			}
 		}
 * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'}
 * filter.
 *
 * @since 3.0.0
 *
-* @param int    $id          Optional. A post or site id. Default is 0, which means the current post or site.
+* @param int    $id          Optional. A post or site ID. Default is 0, which means the current post or site.
-* @param string $context     Optional. Whether the id is a 'site' id, 'post' id, or 'media' id. If 'post',
+* @param string $context     Optional. Whether the ID is a 'site' id, 'post' id, or 'media' id. If 'post',
 *                            the post_type of the post is consulted. If 'query', the current query is consulted
-*                            to determine the id and context. Default 'post'.
+*                            to determine the ID and context. Default 'post'.
 * @param bool   $allow_slugs Optional. Whether to allow post slugs in the shortlink. It is up to the plugin how
 *                            and whether to honor this. Default true.
 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks
 *                are not enabled.
 */
 function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) {
 	/**
 	 * Filters whether to preempt generating a shortlink for the given post.
 	 *
-	 * Passing a truthy value to the filter will effectively short-circuit the
+	 * Returning a truthy value from the filter will effectively short-circuit
-	 * shortlink-generation process, returning that value instead.
+	 * the shortlink generation process, returning that value instead.
 	 *
 	 * @since 3.0.0
 	 *
-	 * @param bool|string $return      Short-circuit return value. Either false or a URL string.
+	 * @param false|string $return      Short-circuit return value. Either false or a URL string.
-	 * @param int         $id          Post ID, or 0 for the current post.
+	 * @param int          $id          Post ID, or 0 for the current post.
-	 * @param string      $context     The context for the link. One of 'post' or 'query',
+	 * @param string       $context     The context for the link. One of 'post' or 'query',
-	 * @param bool        $allow_slugs Whether to allow post slugs in the shortlink.
+	 * @param bool         $allow_slugs Whether to allow post slugs in the shortlink.
 	 */
 	$shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );
 	if ( false !== $shortlink ) {
 		return $shortlink;
 	}
 	$post_id = 0;
-	if ( 'query' == $context && is_singular() ) {
+	if ( 'query' === $context && is_singular() ) {
 		$post_id = get_queried_object_id();
 		$post    = get_post( $post_id );
-	} elseif ( 'post' == $context ) {
+	} elseif ( 'post' === $context ) {
 		$post = get_post( $id );
 		if ( ! empty( $post->ID ) ) {
 			$post_id = $post->ID;
 		}
 	}
 	$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 );
-		if ( 'page' === $post->post_type && $post->ID == get_option( 'page_on_front' ) && 'page' == get_option( 'show_on_front' ) ) {
+		if ( 'page' === $post->post_type && get_option( 'page_on_front' ) == $post->ID && 'page' === get_option( 'show_on_front' ) ) {
 			$shortlink = home_url( '/' );
 		} elseif ( $post_type->public ) {
 			$shortlink = home_url( '?p=' . $post_id );
 		}
 	}
 *     @type string $scheme         URL scheme to use. See set_url_scheme() for accepted values.
 *                                  Default null.
 *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
 *                                  plus a "found_avatar" guess. Pass as a reference. Default null.
 * }
-* @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
+* @return string|false The URL of the avatar on success, false on failure.
 */
 function get_avatar_url( $id_or_email, $args = null ) {
 	$args = get_avatar_data( $id_or_email, $args );
 	return $args['url'];
 }
 /**
 * Retrieves default data about the avatar.
 *
 * @since 4.2.0
 *
-* @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+* @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
-*                            user email, WP_User object, WP_Post object, or WP_Comment object.
+*                           user email, WP_User object, WP_Post object, or WP_Comment object.
 * @param array $args {
 *     Optional. Arguments to return instead of the default arguments.
 *
 *     @type int    $size           Height and width of the avatar image file in pixels. Default 96.
 *     @type int    $height         Display height of the avatar in pixels. Defaults to $size.
 *                                  Default null.
 *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
 *                                  plus a "found_avatar" guess. Pass as a reference. Default null.
 *     @type string $extra_attr     HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
 * }
-* @return array $processed_args {
+* @return array {
 *     Along with the arguments passed in `$args`, this will contain a couple of extra arguments.
 *
 *     @type bool   $found_avatar True if we were able to find an avatar for this user,
 *                                false or not set if we couldn't.
 *     @type string $url          The URL of the avatar we found.
 			'width'          => null,
 			'default'        => get_option( 'avatar_default', 'mystery' ),
 			'force_default'  => false,
 			'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'     => '',
 		)
 	);
 	if ( is_numeric( $args['size'] ) ) {
 	 * effectively short circuit get_avatar_data(), passing the value through
 	 * the {@see 'get_avatar_data'} filter and returning early.
 	 *
 	 * @since 4.2.0
 	 *
-	 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
+	 * @param array $args        Arguments passed to get_avatar_data(), after processing.
-	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+	 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
-	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
+	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
 	 */
 	$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
 	if ( isset( $args['url'] ) ) {
 		/** This filter is documented in wp-includes/link-template.php */
 		return apply_filters( 'get_avatar_data', $args, $id_or_email );
 	}
 	$email_hash = '';
-	$user       = $email = false;
+	$user       = false;
+	$email      = false;
 	if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
 		$id_or_email = get_comment( $id_or_email );
 	}
 	// Process the user identifier.
 	if ( is_numeric( $id_or_email ) ) {
 		$user = get_user_by( 'id', absint( $id_or_email ) );
 	} 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 ) {
 		if ( ! is_avatar_comment_type( get_comment_type( $id_or_email ) ) ) {
 			$args['url'] = false;
 			/** This filter is documented in wp-includes/link-template.php */
 	 * Filters the avatar URL.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $url         The URL of the avatar.
-	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
 	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
 	 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
 	 */
 	$args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
 	/**
 	 * Filters the avatar data.
 	 *
 	 * @since 4.2.0
 	 *
-	 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
+	 * @param array $args        Arguments passed to get_avatar_data(), after processing.
-	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+	 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
-	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
+	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
 	 */
 	return apply_filters( 'get_avatar_data', $args, $id_or_email );
 }
 /**
 *
 * @since 4.9.6
 *
 * @param string $before Optional. Display before privacy policy link. Default empty.
 * @param string $after  Optional. Display after privacy policy link. Default empty.
-*
 * @return string Markup for the link and surrounding elements. Empty string if it
 *                doesn't exist.
 */
 function get_the_privacy_policy_link( $before = '', $after = '' ) {
 	$link               = '';

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a