X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/985e04597a9f1ddc4a3b406d0fb33722e097ee8b..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/link-template.php

diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php
index a9f87d6e..0929004e 100644
--- a/wp-includes/link-template.php
+++ b/wp-includes/link-template.php
@@ -31,7 +31,7 @@ function the_permalink() {
  * blog is not set to have them.
  *
  * @since 2.2.0
- * @uses $wp_rewrite
+ * @global WP_Rewrite $wp_rewrite
  *
  * @param string $string URL with or without a trailing slash.
  * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
@@ -55,8 +55,7 @@ function user_trailingslashit($string, $type_of_url = '') {
 	 *                            'single_feed', 'single_paged', 'feed', 'category', 'page', 'year',
 	 *                            'month', 'day', 'paged', 'post_type_archive'.
 	 */
-	$string = apply_filters( 'user_trailingslashit', $string, $type_of_url );
-	return $string;
+	return apply_filters( 'user_trailingslashit', $string, $type_of_url );
 }
 
 /**
@@ -94,7 +93,7 @@ function permalink_anchor( $mode = 'id' ) {
  *
  * @param int|WP_Post $id        Optional. Post ID or post object. Default is the current post.
  * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
- * @return string|bool The permalink URL or false if post does not exist.
+ * @return string|false The permalink URL or false if post does not exist.
  */
 function get_the_permalink( $id = 0, $leavename = false ) {
 	return get_permalink( $id, $leavename );
@@ -107,7 +106,7 @@ function get_the_permalink( $id = 0, $leavename = false ) {
  *
  * @param int|WP_Post $id        Optional. Post ID or post object. Default current post.
  * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
- * @return string|bool The permalink URL or false if post does not exist.
+ * @return string|false The permalink URL or false if post does not exist.
  */
 function get_permalink( $id = 0, $leavename = false ) {
 	$rewritecode = array(
@@ -157,7 +156,7 @@ function get_permalink( $id = 0, $leavename = false ) {
 	 */
 	$permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename );
 
-	if ( '' != $permalink && !in_array($post->post_status, array('draft', 'pending', 'auto-draft')) ) {
+	if ( '' != $permalink && !in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ) ) ) {
 		$unixtime = strtotime($post->post_date);
 
 		$category = '';
@@ -236,10 +235,12 @@ function get_permalink( $id = 0, $leavename = false ) {
  *
  * @since 3.0.0
  *
- * @param int $id Optional. Post ID.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $id         Optional. Post ID.
  * @param bool $leavename Optional, defaults to false. Whether to keep post name.
- * @param bool $sample Optional, defaults to false. Is it a sample permalink.
- * @return string The post permalink.
+ * @param bool $sample    Optional, defaults to false. Is it a sample permalink.
+ * @return string|WP_Error The post permalink.
  */
 function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
 	global $wp_rewrite;
@@ -253,7 +254,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
 
 	$slug = $post->post_name;
 
-	$draft_or_pending = isset($post->post_status) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
+	$draft_or_pending = isset( $post->post_status ) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ) );
 
 	$post_type = get_post_type_object($post->post_type);
 
@@ -292,9 +293,9 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
  *
  * @since 1.0.0
  *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
- * @param mixed $deprecated Not used.
- * @return string
+ * @param int|WP_Post $post_id    Optional. Post ID or WP_Post object. Default is global $post.
+ * @param mixed       $deprecated Not used.
+ * @return string|false
  */
 function post_permalink( $post_id = 0, $deprecated = '' ) {
 	if ( !empty( $deprecated ) )
@@ -310,9 +311,9 @@ function post_permalink( $post_id = 0, $deprecated = '' ) {
  *
  * @since 1.5.0
  *
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional, defaults to false. Whether to keep page name.
- * @param bool $sample Optional, defaults to false. Is it a sample permalink.
+ * @param int|object $post      Optional. Post ID or object.
+ * @param bool       $leavename Optional, defaults to false. Whether to keep page name.
+ * @param bool       $sample    Optional, defaults to false. Is it a sample permalink.
  * @return string The page permalink.
  */
 function get_page_link( $post = false, $leavename = false, $sample = false ) {
@@ -343,9 +344,11 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) {
  * @since 2.1.0
  * @access private
  *
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional. Leave name.
- * @param bool $sample Optional. Sample permalink.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int|object $post      Optional. Post ID or object.
+ * @param bool       $leavename Optional. Leave name.
+ * @param bool       $sample    Optional. Sample permalink.
  * @return string The page permalink.
  */
 function _get_page_link( $post = false, $leavename = false, $sample = false ) {
@@ -386,8 +389,10 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) {
  *
  * @since 2.0.0
  *
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional. Leave name.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int|object $post      Optional. Post ID or object.
+ * @param bool       $leavename Optional. Leave name.
  * @return string The attachment permalink.
  */
 function get_attachment_link( $post = null, $leavename = false ) {
@@ -435,6 +440,8 @@ function get_attachment_link( $post = null, $leavename = false ) {
  *
  * @since 1.5.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param int|bool $year False for current year or year for permalink.
  * @return string The permalink for the specified year archive.
  */
@@ -466,7 +473,9 @@ function get_year_link($year) {
  *
  * @since 1.0.0
  *
- * @param bool|int $year False for current year. Integer of year.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param bool|int $year  False for current year. Integer of year.
  * @param bool|int $month False for current month. Integer of month.
  * @return string The permalink for the specified month and year archive.
  */
@@ -502,9 +511,11 @@ function get_month_link($year, $month) {
  *
  * @since 1.0.0
  *
- * @param bool|int $year False for current year. Integer of year.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param bool|int $year  False for current year. Integer of year.
  * @param bool|int $month False for current month. Integer of month.
- * @param bool|int $day False for current day. Integer of day.
+ * @param bool|int $day   False for current day. Integer of day.
  * @return string The permalink for the specified day, month, and year archive.
  */
 function get_day_link($year, $month, $day) {
@@ -545,7 +556,7 @@ function get_day_link($year, $month, $day) {
  * @since 3.0.0
  *
  * @param string $anchor The link's anchor text.
- * @param string $feed Optional, defaults to default feed. Feed type.
+ * @param string $feed   Optional, defaults to default feed. Feed type.
  */
 function the_feed_link( $anchor, $feed = '' ) {
 	$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
@@ -567,6 +578,8 @@ function the_feed_link( $anchor, $feed = '' ) {
  *
  * @since 1.5.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string $feed Optional, defaults to default feed. Feed type.
  * @return string The feed permalink.
  */
@@ -612,8 +625,8 @@ function get_feed_link($feed = '') {
  *
  * @since 2.2.0
  *
- * @param int $post_id Optional. Post ID.
- * @param string $feed Optional. Feed type.
+ * @param int    $post_id Optional. Post ID.
+ * @param string $feed    Optional. Feed type.
  * @return string The permalink for the comments feed for the given post.
  */
 function get_post_comments_feed_link($post_id = 0, $feed = '') {
@@ -663,9 +676,8 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') {
  * @since 2.5.0
  *
  * @param string $link_text Descriptive text.
- * @param int $post_id Optional post ID. Default to current post.
- * @param string $feed Optional. Feed format.
- * @return string Link to the comment feed for the current post.
+ * @param int    $post_id   Optional post ID. Default to current post.
+ * @param string $feed      Optional. Feed format.
 */
 function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
 	$url = esc_url( get_post_comments_feed_link( $post_id, $feed ) );
@@ -692,8 +704,8 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
  *
  * @since 2.5.0
  *
- * @param int $author_id ID of an author.
- * @param string $feed Optional. Feed type.
+ * @param int    $author_id ID of an author.
+ * @param string $feed      Optional. Feed type.
  * @return string Link to the feed for the author specified by $author_id.
 */
 function get_author_feed_link( $author_id, $feed = '' ) {
@@ -736,12 +748,12 @@ function get_author_feed_link( $author_id, $feed = '' ) {
  *
  * @since 2.5.0
  *
- * @param int $cat_id ID of a category.
- * @param string $feed Optional. Feed type.
+ * @param int    $cat_id ID of a category.
+ * @param string $feed   Optional. Feed type.
  * @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);
+function get_category_feed_link( $cat_id, $feed = '' ) {
+	return get_term_feed_link( $cat_id, 'category', $feed );
 }
 
 /**
@@ -752,10 +764,10 @@ function get_category_feed_link($cat_id, $feed = '') {
  *
  * @since 3.0.0
  *
- * @param int $term_id ID of a category.
+ * @param int    $term_id  ID of a category.
  * @param string $taxonomy Optional. Taxonomy of $term_id
- * @param string $feed Optional. Feed type.
- * @return string Link to the feed for the term specified by $term_id and $taxonomy.
+ * @param string $feed     Optional. Feed type.
+ * @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;
@@ -831,12 +843,12 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
  *
  * @since 2.3.0
  *
- * @param int $tag_id Tag ID.
- * @param string $feed Optional. Feed type.
+ * @param int    $tag_id Tag ID.
+ * @param string $feed   Optional. Feed type.
  * @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);
+function get_tag_feed_link( $tag_id, $feed = '' ) {
+	return get_term_feed_link( $tag_id, 'post_tag', $feed );
 }
 
 /**
@@ -844,7 +856,7 @@ function get_tag_feed_link($tag_id, $feed = '') {
  *
  * @since 2.7.0
  *
- * @param int $tag_id Tag ID
+ * @param int    $tag_id   Tag ID
  * @param string $taxonomy Taxonomy
  * @return string The edit tag link URL for the given tag.
  */
@@ -864,11 +876,10 @@ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
  *
  * @since 2.7.0
  *
- * @param string $link Optional. Anchor text.
+ * @param string $link   Optional. Anchor text.
  * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param object $tag Tag object.
- * @return string HTML content.
+ * @param string $after  Optional. Display after edit link.
+ * @param object $tag    Tag object.
  */
 function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
 	$link = edit_term_link( $link, '', '', $tag, false );
@@ -888,17 +899,22 @@ function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
  *
  * @since 3.1.0
  *
- * @param int $term_id Term ID
- * @param string $taxonomy Taxonomy
- * @param string $object_type The object type
- * @return string The edit term link URL for the given term.
+ * @param int    $term_id     Term ID.
+ * @param string $taxonomy    Taxonomy.
+ * @param string $object_type The object type. Used to highlight the proper post type menu on the linked page.
+ *                            Defaults to the first object_type associated with the taxonomy.
+ * @return string|null The edit term link URL for the given term, or null on failure.
  */
 function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
 	$tax = get_taxonomy( $taxonomy );
-	if ( !current_user_can( $tax->cap->edit_terms ) )
+	if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) {
 		return;
+	}
 
 	$term = get_term( $term_id, $taxonomy );
+	if ( ! $term || is_wp_error( $term ) ) {
+		return;
+	}
 
 	$args = array(
 		'action' => 'edit',
@@ -906,8 +922,11 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
 		'tag_ID' => $term->term_id,
 	);
 
-	if ( $object_type )
+	if ( $object_type ) {
 		$args['post_type'] = $object_type;
+	} elseif ( ! empty( $tax->object_type ) ) {
+		$args['post_type'] = reset( $tax->object_type );
+	}
 
 	$location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
 
@@ -929,11 +948,12 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
  *
  * @since 3.1.0
  *
- * @param string $link Optional. Anchor text.
- * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param object $term Term object.
- * @return string HTML content.
+ * @param string $link   Optional. Anchor text. Default empty.
+ * @param string $before Optional. Display before 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 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 ) )
@@ -972,6 +992,8 @@ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $e
  *
  * @since  3.0.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string $query Optional. The query string to use. If empty the current query is used.
  * @return string The search permalink.
  */
@@ -1010,8 +1032,10 @@ function get_search_link( $query = '' ) {
  *
  * @since 2.5.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string $search_query Optional. Search query.
- * @param string $feed Optional. Feed type.
+ * @param string $feed         Optional. Feed type.
  * @return string The search results feed permalink.
  */
 function get_search_feed_link($search_query = '', $feed = '') {
@@ -1039,9 +1063,7 @@ function get_search_feed_link($search_query = '', $feed = '') {
 	 * @param string $feed Feed type.
 	 * @param string $type The search type. One of 'posts' or 'comments'.
 	 */
-	$link = apply_filters( 'search_feed_link', $link, $feed, 'posts' );
-
-	return $link;
+	return apply_filters( 'search_feed_link', $link, $feed, 'posts' );
 }
 
 /**
@@ -1049,8 +1071,10 @@ function get_search_feed_link($search_query = '', $feed = '') {
  *
  * @since 2.5.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string $search_query Optional. Search query.
- * @param string $feed Optional. Feed type.
+ * @param string $feed         Optional. Feed type.
  * @return string The comments feed search results permalink.
  */
 function get_search_comments_feed_link($search_query = '', $feed = '') {
@@ -1069,9 +1093,7 @@ function get_search_comments_feed_link($search_query = '', $feed = '') {
 		$link = add_query_arg('withcomments', 1, $link);
 
 	/** This filter is documented in wp-includes/link-template.php */
-	$link = apply_filters('search_feed_link', $link, $feed, 'comments');
-
-	return $link;
+	return apply_filters( 'search_feed_link', $link, $feed, 'comments' );
 }
 
 /**
@@ -1079,8 +1101,10 @@ function get_search_comments_feed_link($search_query = '', $feed = '') {
  *
  * @since 3.1.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string $post_type Post type
- * @return string The post type archive permalink.
+ * @return string|false The post type archive permalink.
  */
 function get_post_type_archive_link( $post_type ) {
 	global $wp_rewrite;
@@ -1118,8 +1142,8 @@ function get_post_type_archive_link( $post_type ) {
  * @since 3.1.0
  *
  * @param string $post_type Post type
- * @param string $feed Optional. Feed type
- * @return string The post type feed permalink.
+ * @param string $feed      Optional. Feed type
+ * @return string|false The post type feed permalink.
  */
 function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
 	$default_feed = get_default_feed();
@@ -1158,9 +1182,9 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
  *
  * @since 2.3.0
  *
- * @param int $id Optional. Post ID.
+ * @param int    $id      Optional. Post ID.
  * @param string $context Optional, defaults to display. How to write the '&', defaults to '&amp;'.
- * @return string The edit post link for the given post.
+ * @return string|void The edit post link for the given post.
  */
 function get_edit_post_link( $id = 0, $context = 'display' ) {
 	if ( ! $post = get_post( $id ) )
@@ -1198,10 +1222,10 @@ function get_edit_post_link( $id = 0, $context = 'display' ) {
  *
  * @since 1.0.0
  *
- * @param string $text Optional. Anchor text.
+ * @param string $text   Optional. Anchor text.
  * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param int $id Optional. Post ID.
+ * @param string $after  Optional. Display after edit link.
+ * @param int    $id     Optional. Post ID.
  */
 function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
 	if ( ! $post = get_post( $id ) ) {
@@ -1237,10 +1261,10 @@ function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
  *
  * @since 2.9.0
  *
- * @param int $id Optional. Post ID.
- * @param string $deprecated Not used.
- * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
- * @return string The delete post link URL for the given post.
+ * @param int    $id           Optional. Post ID.
+ * @param string $deprecated   Not used.
+ * @param bool   $force_delete Whether to bypass trash and force deletion. Default is 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 ) )
@@ -1278,7 +1302,7 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false
  * @since 2.3.0
  *
  * @param int $comment_id Optional. Comment ID.
- * @return string The edit comment link URL for the given comment.
+ * @return string|void The edit comment link URL for the given comment.
  */
 function get_edit_comment_link( $comment_id = 0 ) {
 	$comment = get_comment( $comment_id );
@@ -1303,9 +1327,11 @@ function get_edit_comment_link( $comment_id = 0 ) {
  *
  * @since 1.0.0
  *
- * @param string $text Optional. Anchor text.
+ * @global object $comment
+ *
+ * @param string $text   Optional. Anchor text.
  * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
+ * @param string $after  Optional. Display after edit link.
  */
 function edit_comment_link( $text = null, $before = '', $after = '' ) {
 	global $comment;
@@ -1337,8 +1363,8 @@ function edit_comment_link( $text = null, $before = '', $after = '' ) {
  *
  * @since 2.7.0
  *
- * @param int $link Optional. Bookmark ID.
- * @return string The edit bookmark link URL.
+ * @param int|stdClass $link Optional. Bookmark ID.
+ * @return string|void The edit bookmark link URL.
  */
 function get_edit_bookmark_link( $link = 0 ) {
 	$link = get_bookmark( $link );
@@ -1364,10 +1390,10 @@ function get_edit_bookmark_link( $link = 0 ) {
  *
  * @since 2.7.0
  *
- * @param string $link Optional. Anchor text.
- * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param int $bookmark Optional. Bookmark ID.
+ * @param string $link     Optional. Anchor text.
+ * @param string $before   Optional. Display before edit link.
+ * @param string $after    Optional. Display after edit link.
+ * @param int    $bookmark Optional. Bookmark ID.
  */
 function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
 	$bookmark = get_bookmark($bookmark);
@@ -1437,7 +1463,7 @@ function get_edit_user_link( $user_id = null ) {
  * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term.
  * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed       Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
 	return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
@@ -1451,7 +1477,7 @@ function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxono
  * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term.
  * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed       Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
 	return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
@@ -1464,11 +1490,13 @@ function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy =
  *
  * @since 2.5.0
  *
+ * @global wpdb $wpdb
+ *
  * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term.
  * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
  * @param bool         $previous       Optional. Whether to retrieve previous post.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed       Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
  */
 function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
 	global $wpdb;
@@ -1517,6 +1545,36 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
 		}
 	}
 
+	// 'post_status' clause depends on the current user.
+	if ( is_user_logged_in() ) {
+		$user_id = get_current_user_id();
+
+		$post_type_object = get_post_type_object( $post->post_type );
+		if ( empty( $post_type_object ) ) {
+			$post_type_cap    = $post->post_type;
+			$read_private_cap = 'read_private_' . $post_type_cap . 's';
+		} else {
+			$read_private_cap = $post_type_object->cap->read_private_posts;
+		}
+
+		/*
+		 * Results should include private posts belonging to the current user, or private posts where the
+		 * current user has the 'read_private_posts' cap.
+		 */
+		$private_states = get_post_stati( array( 'private' => true ) );
+		$where .= " AND ( p.post_status = 'publish'";
+		foreach ( (array) $private_states as $state ) {
+			if ( current_user_can( $read_private_cap ) ) {
+				$where .= $wpdb->prepare( " OR p.post_status = %s", $state );
+			} else {
+				$where .= $wpdb->prepare( " OR (p.post_author = %d AND p.post_status = %s)", $user_id, $state );
+			}
+		}
+		$where .= " )";
+	} else {
+		$where .= " AND p.post_status = 'publish'";
+	}
+
 	$adjacent = $previous ? 'previous' : 'next';
 	$op = $previous ? '<' : '>';
 	$order = $previous ? 'DESC' : 'ASC';
@@ -1547,7 +1605,7 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
 	 * @param bool   $in_same_term   Whether post should be in a same taxonomy term.
 	 * @param array  $excluded_terms Array of excluded term IDs.
 	 */
-	$where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s AND p.post_status = 'publish' $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms );
+	$where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms );
 
 	/**
 	 * Filter the ORDER BY clause in the SQL for an adjacent post query.
@@ -1594,7 +1652,7 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
  * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
  * @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 The adjacent post relational link URL.
+ * @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() )
@@ -1703,7 +1761,7 @@ function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded
  * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
  * @param bool         $start          Optional. Whether to retrieve first or last post.
  * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed Array containing the boundary post object if successful, null otherwise.
+ * @return null|array Array containing the boundary post object if successful, null otherwise.
  */
 function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
 	$post = get_post();
@@ -1865,13 +1923,15 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.6.0
+	 * @since 4.2.0 Added the `$adjacent` parameter.
 	 *
-	 * @param string  $output The adjacent post link.
-	 * @param string  $format Link anchor format.
-	 * @param string  $link   Link permalink format.
-	 * @param WP_Post $post   The adjacent post.
+	 * @param string  $output   The adjacent post link.
+	 * @param string  $format   Link anchor format.
+	 * @param string  $link     Link permalink format.
+	 * @param WP_Post $post     The adjacent post.
+	 * @param string  $adjacent Whether the post is previous or next.
 	 */
-	return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post );
+	return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post, $adjacent );
 }
 
 /**
@@ -1897,9 +1957,11 @@ function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_te
  *
  * @since 1.5.0
  *
- * @param int $pagenum Optional. Page ID.
- * @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().
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int  $pagenum Optional. Page ID.
+ * @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.
  */
 function get_pagenum_link($pagenum = 1, $escape = true ) {
@@ -1973,8 +2035,10 @@ function get_pagenum_link($pagenum = 1, $escape = true ) {
  *
  * @since 2.0.10
  *
+ * @global int $paged
+ *
  * @param int $max_page Optional. Max pages.
- * @return string The link URL for next posts page.
+ * @return string|void The link URL for next posts page.
  */
 function get_next_posts_page_link($max_page = 0) {
 	global $paged;
@@ -1993,9 +2057,9 @@ function get_next_posts_page_link($max_page = 0) {
  *
  * @since 0.71
  *
- * @param int $max_page Optional. Max pages.
- * @param boolean $echo Optional. Echo or return;
- * @return string The link URL for next posts page if `$echo = false`.
+ * @param int   $max_page Optional. Max pages.
+ * @param bool  $echo     Optional. Echo or return;
+ * @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 ) );
@@ -2011,9 +2075,12 @@ function next_posts( $max_page = 0, $echo = true ) {
  *
  * @since 2.7.0
  *
- * @param string $label Content for link text.
- * @param int $max_page Optional. Max pages.
- * @return string|null HTML-formatted next posts page link.
+ * @global int      $paged
+ * @global WP_Query $wp_query
+ *
+ * @param string $label    Content for link text.
+ * @param int    $max_page Optional. Max pages.
+ * @return string|void HTML-formatted next posts page link.
  */
 function get_next_posts_link( $label = null, $max_page = 0 ) {
 	global $paged, $wp_query;
@@ -2048,8 +2115,8 @@ function get_next_posts_link( $label = null, $max_page = 0 ) {
  *
  * @since 0.71
  *
- * @param string $label Content for link text.
- * @param int $max_page Optional. Max pages.
+ * @param string $label    Content for link text.
+ * @param int    $max_page Optional. Max pages.
  */
 function next_posts_link( $label = null, $max_page = 0 ) {
 	echo get_next_posts_link( $label, $max_page );
@@ -2064,7 +2131,9 @@ function next_posts_link( $label = null, $max_page = 0 ) {
  *
  * @since 2.0.10
  *
- * @return string|null The link for the previous posts page.
+ * @global int $paged
+ *
+ * @return string|void The link for the previous posts page.
  */
 function get_previous_posts_page_link() {
 	global $paged;
@@ -2082,8 +2151,8 @@ function get_previous_posts_page_link() {
  *
  * @since 0.71
  *
- * @param boolean $echo Optional. Echo or return;
- * @return string The previous posts page link if `$echo = false`.
+ * @param bool $echo Optional. Echo or return;
+ * @return string|void The previous posts page link if `$echo = false`.
  */
 function previous_posts( $echo = true ) {
 	$output = esc_url( get_previous_posts_page_link() );
@@ -2099,8 +2168,10 @@ function previous_posts( $echo = true ) {
  *
  * @since 2.7.0
  *
+ * @global int $paged
+ *
  * @param string $label Optional. Previous page link text.
- * @return string|null HTML-formatted previous page link.
+ * @return string|void HTML-formatted previous page link.
  */
 function get_previous_posts_link( $label = null ) {
 	global $paged;
@@ -2137,6 +2208,8 @@ function previous_posts_link( $label = null ) {
  *
  * @since 2.8.0
  *
+ * @global WP_Query $wp_query
+ *
  * @param string|array $args Optional args.
  * @return string The posts link navigation.
  */
@@ -2176,7 +2249,7 @@ function get_posts_nav_link( $args = array() ) {
  *
  * @since 0.71
  *
- * @param string $sep Optional. Separator for posts navigation links.
+ * @param string $sep      Optional. Separator for posts navigation links.
  * @param string $prelabel Optional. Label for previous pages.
  * @param string $nxtlabel Optional Label for next pages.
  */
@@ -2374,7 +2447,9 @@ function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader
  *
  * @since 2.7.0
  *
- * @param int $pagenum Optional. Page number.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $pagenum  Optional. Page number.
  * @param int $max_page Optional. The maximum number of comment pages.
  * @return string The comments page number link URL.
  */
@@ -2388,13 +2463,13 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
 	if ( 'newest' == get_option('default_comments_page') ) {
 		if ( $pagenum != $max_page ) {
 			if ( $wp_rewrite->using_permalinks() )
-				$result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
+				$result = user_trailingslashit( trailingslashit($result) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged');
 			else
 				$result = add_query_arg( 'cpage', $pagenum, $result );
 		}
 	} elseif ( $pagenum > 1 ) {
 		if ( $wp_rewrite->using_permalinks() )
-			$result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
+			$result = user_trailingslashit( trailingslashit($result) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged');
 		else
 			$result = add_query_arg( 'cpage', $pagenum, $result );
 	}
@@ -2408,9 +2483,7 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
 	 *
 	 * @param string $result The comments page number link.
 	 */
-	$result = apply_filters( 'get_comments_pagenum_link', $result );
-
-	return $result;
+	return apply_filters( 'get_comments_pagenum_link', $result );
 }
 
 /**
@@ -2418,9 +2491,11 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
  *
  * @since 2.7.1
  *
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
- * @return string|null HTML-formatted link for the next page of comments.
+ * @global WP_Query $wp_query
+ *
+ * @param string $label    Optional. Label for link text.
+ * @param int    $max_page Optional. Max page.
+ * @return string|void HTML-formatted link for the next page of comments.
  */
 function get_next_comments_link( $label = '', $max_page = 0 ) {
 	global $wp_query;
@@ -2430,6 +2505,10 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
 
 	$page = get_query_var('cpage');
 
+	if ( ! $page ) {
+		$page = 1;
+	}
+
 	$nextpage = intval($page) + 1;
 
 	if ( empty($max_page) )
@@ -2459,8 +2538,8 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
  *
  * @since 2.7.0
  *
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
+ * @param string $label    Optional. Label for link text.
+ * @param int    $max_page Optional. Max page.
  */
 function next_comments_link( $label = '', $max_page = 0 ) {
 	echo get_next_comments_link( $label, $max_page );
@@ -2472,7 +2551,7 @@ function next_comments_link( $label = '', $max_page = 0 ) {
  * @since 2.7.1
  *
  * @param string $label Optional. Label for comments link text.
- * @return string|null HTML-formatted link for the previous page of comments.
+ * @return string|void HTML-formatted link for the previous page of comments.
  */
 function get_previous_comments_link( $label = '' ) {
 	if ( !is_singular() || !get_option('page_comments') )
@@ -2515,8 +2594,10 @@ function previous_comments_link( $label = '' ) {
  * @see paginate_links()
  * @since 2.7.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @param string|array $args Optional args. See paginate_links().
- * @return string Markup for pagination links.
+ * @return string|void Markup for pagination links.
 */
 function paginate_comments_links($args = array()) {
 	global $wp_rewrite;
@@ -2537,7 +2618,7 @@ function paginate_comments_links($args = array()) {
 		'add_fragment' => '#comments'
 	);
 	if ( $wp_rewrite->using_permalinks() )
-		$defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . 'comment-page-%#%', 'commentpaged');
+		$defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . $wp_rewrite->comments_pagination_base . '-%#%', 'commentpaged');
 
 	$args = wp_parse_args( $args, $defaults );
 	$page_links = paginate_links( $args );
@@ -2555,26 +2636,50 @@ function paginate_comments_links($args = array()) {
  *
  * @since 2.6.0
  *
+ * @global bool          $is_IE
+ * @global string        $wp_version
+ * @global WP_Press_This $wp_press_this
+ *
  * @return string The Press This bookmarklet link URL.
  */
 function get_shortcut_link() {
-	// In case of breaking changes, version this. #WP20071
-	$link = "javascript:
-			var d=document,
-			w=window,
-			e=w.getSelection,
-			k=d.getSelection,
-			x=d.selection,
-			s=(e?e():(k)?k():(x?x.createRange().text:0)),
-			f='" . admin_url('press-this.php') . "',
-			l=d.location,
-			e=encodeURIComponent,
-			u=f+'?u='+e(l.href)+'&t='+e(d.title)+'&s='+e(s)+'&v=4';
-			a=function(){if(!w.open(u,'t','toolbar=0,resizable=1,scrollbars=1,status=1,width=720,height=570'))l.href=u;};
-			if (/Firefox/.test(navigator.userAgent)) setTimeout(a, 0); else a();
-			void(0)";
-
-	$link = str_replace(array("\r", "\n", "\t"),  '', $link);
+	global $is_IE, $wp_version;
+
+	include_once( ABSPATH . 'wp-admin/includes/class-wp-press-this.php' );
+	$bookmarklet_version = $GLOBALS['wp_press_this']->version;
+	$link = '';
+
+	if ( $is_IE ) {
+		/**
+		 * Return the old/shorter bookmarklet code for MSIE 8 and lower,
+		 * since they only support a max length of ~2000 characters for
+		 * bookmark[let] URLs, which is way to small for our smarter one.
+		 * Do update the version number so users do not get the "upgrade your
+		 * bookmarklet" notice when using PT in those browsers.
+		 */
+		$ua = $_SERVER['HTTP_USER_AGENT'];
+
+		if ( ! empty( $ua ) && preg_match( '/\bMSIE (\d)/', $ua, $matches ) && (int) $matches[1] <= 8 ) {
+			$url = wp_json_encode( admin_url( 'press-this.php' ) );
+
+			$link = 'javascript:var d=document,w=window,e=w.getSelection,k=d.getSelection,x=d.selection,' .
+				's=(e?e():(k)?k():(x?x.createRange().text:0)),f=' . $url . ',l=d.location,e=encodeURIComponent,' .
+				'u=f+"?u="+e(l.href)+"&t="+e(d.title)+"&s="+e(s)+"&v=' . $bookmarklet_version . '";' .
+				'a=function(){if(!w.open(u,"t","toolbar=0,resizable=1,scrollbars=1,status=1,width=600,height=700"))l.href=u;};' .
+				'if(/Firefox/.test(navigator.userAgent))setTimeout(a,0);else a();void(0)';
+		}
+	}
+
+	if ( empty( $link ) ) {
+		$src = @file_get_contents( ABSPATH . 'wp-admin/js/bookmarklet.min.js' );
+
+		if ( $src ) {
+			$url = wp_json_encode( admin_url( 'press-this.php' ) . '?v=' . $bookmarklet_version );
+			$link = 'javascript:' . str_replace( 'window.pt_url', $url, $src );
+		}
+	}
+
+	$link = str_replace( array( "\r", "\n", "\t" ),  '', $link );
 
 	/**
 	 * Filter the Press This bookmarklet link.
@@ -2614,6 +2719,8 @@ function home_url( $path = '', $scheme = null ) {
  *
  * @since 3.0.0
  *
+ * @global string $pagenow
+ *
  * @param  int         $blog_id     Optional. Blog ID. Default null (current blog).
  * @param  string      $path        Optional. Path relative to the home URL. Default empty.
  * @param  string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
@@ -2665,7 +2772,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
  *
  * @since 3.0.0
  *
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path   Optional. Path relative to the site url.
  * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
  * @return string Site url link with optional path appended.
 */
@@ -2722,7 +2829,7 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
  *
  * @since 2.6.0
  *
- * @param string $path Optional path relative to the admin url.
+ * @param string $path   Optional path relative to the admin url.
  * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
  * @return string Admin url link with optional path appended.
 */
@@ -2765,7 +2872,7 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
  *
  * @since 2.6.0
  *
- * @param string $path Optional. Path relative to the includes url.
+ * @param string $path   Optional. Path relative to the includes url.
  * @param string $scheme Optional. Scheme to give the includes url context.
  * @return string Includes url link with optional path appended.
 */
@@ -2873,7 +2980,7 @@ function plugins_url( $path = '', $plugin = '' ) {
  *
  * @since 3.0.0
  *
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path   Optional. Path relative to the site url.
  * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
  * @return string Site url link with optional path appended.
 */
@@ -2956,7 +3063,7 @@ function network_home_url( $path = '', $scheme = null ) {
  *
  * @since 3.0.0
  *
- * @param string $path Optional path relative to the admin url.
+ * @param string $path   Optional path relative to the admin url.
  * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
  * @return string Admin url link with optional path appended.
 */
@@ -2986,7 +3093,7 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
  *
  * @since 3.0.0
  *
- * @param string $path Optional path relative to the admin url.
+ * @param string $path   Optional path relative to the admin url.
  * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
  * @return string Admin url link with optional path appended.
 */
@@ -3013,7 +3120,7 @@ function user_admin_url( $path = '', $scheme = 'admin' ) {
  *
  * @since 3.1.0
  *
- * @param string $path Optional path relative to the admin url.
+ * @param string $path   Optional path relative to the admin url.
  * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
  * @return string Admin url link with optional path appended.
 */
@@ -3031,7 +3138,7 @@ function self_admin_url($path = '', $scheme = 'admin') {
  *
  * @since 3.4.0
  *
- * @param string $url Absolute url that includes a scheme
+ * @param string $url    Absolute url that includes a scheme
  * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
  * @return string $url URL with chosen scheme.
  */
@@ -3080,9 +3187,9 @@ function set_url_scheme( $url, $scheme = null ) {
  *
  * @since 3.1.0
  *
- * @param int $user_id Optional. User ID. Defaults to current user.
- * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
- * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
+ * @param int    $user_id Optional. User ID. Defaults to current user.
+ * @param string $path    Optional path relative to the dashboard. Use only paths known to both blog and user admins.
+ * @param string $scheme  The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
  * @return string Dashboard url link with optional path appended.
  */
 function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
@@ -3157,6 +3264,8 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
  * Output rel=canonical for singular queries.
  *
  * @since 2.9.0
+ *
+ * @global WP_Query $wp_the_query
 */
 function rel_canonical() {
 	if ( !is_singular() )
@@ -3184,9 +3293,14 @@ function rel_canonical() {
  *
  * @since 3.0.0.
  *
- * @param int $id A post or blog id. Default is 0, which means the current post or blog.
- * @param string $context Whether the id is a 'blog' 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 is 'post'.
- * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
+ * @global WP_Query $wp_query
+ *
+ * @param int    $id          A post or blog id. Default is 0, which means the current post or blog.
+ * @param string $context     Whether the id is a 'blog' 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 is 'post'.
+ * @param bool   $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
  * @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) {
@@ -3289,10 +3403,10 @@ function wp_shortlink_header() {
  *
  * @since 3.0.0
  *
- * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
- * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
+ * @param string $text   Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
+ * @param string $title  Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
  * @param string $before Optional HTML to display before the link.
- * @param string $after Optional HTML to display after the link.
+ * @param string $after  Optional HTML to display after the link.
  */
 function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
 	$post = get_post();
@@ -3322,3 +3436,254 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
 		echo $before, $link, $after;
 	}
 }
+
+
+/**
+ * Retrieve the avatar URL.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
+ *                           user email, WP_User object, WP_Post object, or comment object.
+ * @param array $args {
+ *     Optional. Arguments to return instead of the default arguments.
+ *
+ *     @type int    $size           Height and width of the avatar in pixels. Default 96.
+ *     @type string $default        URL for the default image or a default type. Accepts '404' (return
+ *                                  a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ *                                  'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ *                                  or 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ *                                  'gravatar_default' (the Gravatar logo). Default is the value of the
+ *                                  'avatar_default' option, with a fallback of 'mystery'.
+ *     @type bool   $force_default  Whether to always show the default image, never the Gravatar. Default false.
+ *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ *                                  judged in that order. Default is the value of the 'avatar_rating' option.
+ *     @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.
+ */
+function get_avatar_url( $id_or_email, $args = null ) {
+	$args = get_avatar_data( $id_or_email, $args );
+	return $args['url'];
+}
+
+/**
+ * Retrieve default data about the avatar.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
+ *                           user email, WP_User object, WP_Post object, or 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.
+ *     @type int    $width          Display width of the avatar in pixels. Defaults to $size.
+ *     @type string $default        URL for the default image or a default type. Accepts '404' (return
+ *                                  a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ *                                  'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ *                                  or 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ *                                  'gravatar_default' (the Gravatar logo). Default is the value of the
+ *                                  'avatar_default' option, with a fallback of 'mystery'.
+ *     @type bool   $force_default  Whether to always show the default image, never the Gravatar. Default false.
+ *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ *                                  judged in that order. Default is the value of the 'avatar_rating' option.
+ *     @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.
+ *     @type string $extra_attr     HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
+ * }
+ * @return array $processed_args {
+ *     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.
+ * }
+ */
+function get_avatar_data( $id_or_email, $args = null ) {
+	$args = wp_parse_args( $args, array(
+		'size'           => 96,
+		'height'         => null,
+		'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
+		'extra_attr'     => '',
+	) );
+
+	if ( is_numeric( $args['size'] ) ) {
+		$args['size'] = absint( $args['size'] );
+		if ( ! $args['size'] ) {
+			$args['size'] = 96;
+		}
+	} else {
+		$args['size'] = 96;
+	}
+
+	if ( is_numeric( $args['height'] ) ) {
+		$args['height'] = absint( $args['height'] );
+		if ( ! $args['height'] ) {
+			$args['height'] = $args['size'];
+		}
+	} else {
+		$args['height'] = $args['size'];
+	}
+
+	if ( is_numeric( $args['width'] ) ) {
+		$args['width'] = absint( $args['width'] );
+		if ( ! $args['width'] ) {
+			$args['width'] = $args['size'];
+		}
+	} else {
+		$args['width'] = $args['size'];
+	}
+
+	if ( empty( $args['default'] ) ) {
+		$args['default'] = get_option( 'avatar_default', 'mystery' );
+	}
+
+	switch ( $args['default'] ) {
+		case 'mm' :
+		case 'mystery' :
+		case 'mysteryman' :
+			$args['default'] = 'mm';
+			break;
+		case 'gravatar_default' :
+			$args['default'] = false;
+			break;
+	}
+
+	$args['force_default'] = (bool) $args['force_default'];
+
+	$args['rating'] = strtolower( $args['rating'] );
+
+	$args['found_avatar'] = false;
+
+	/**
+	 * Filter whether to retrieve the avatar URL early.
+	 *
+	 * Passing a non-null value in the 'url' member of the return array will
+	 * 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 int|object|string $id_or_email   A user ID, email address, or comment object.
+	 */
+	$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
+
+	if ( isset( $args['url'] ) && ! is_null( $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;
+
+	// 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
+			list( $email_hash ) = explode( '@', $id_or_email );
+		} else {
+			// email address
+			$email = $id_or_email;
+		}
+	} elseif ( $id_or_email instanceof WP_User ) {
+		// User Object
+		$user = $id_or_email;
+	} elseif ( $id_or_email instanceof WP_Post ) {
+		// Post Object
+		$user = get_user_by( 'id', (int) $id_or_email->post_author );
+	} elseif ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
+		// Comment Object
+
+		/**
+		 * Filter the list of allowed comment types for retrieving avatars.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param array $types An array of content types. Default only contains 'comment'.
+		 */
+		$allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
+		if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
+			$args['url'] = false;
+			/** This filter is documented in wp-includes/link-template.php */
+			return apply_filters( 'get_avatar_data', $args, $id_or_email );
+		}
+
+		if ( ! empty( $id_or_email->user_id ) ) {
+			$user = get_user_by( 'id', (int) $id_or_email->user_id );
+		}
+		if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
+			$email = $id_or_email->comment_author_email;
+		}
+	}
+
+	if ( ! $email_hash ) {
+		if ( $user ) {
+			$email = $user->user_email;
+		}
+
+		if ( $email ) {
+			$email_hash = md5( strtolower( trim( $email ) ) );
+		}
+	}
+
+	if ( $email_hash ) {
+		$args['found_avatar'] = true;
+		$gravatar_server = hexdec( $email_hash[0] ) % 3;
+	} else {
+		$gravatar_server = rand( 0, 2 );
+	}
+
+	$url_args = array(
+		's' => $args['size'],
+		'd' => $args['default'],
+		'f' => $args['force_default'] ? 'y' : false,
+		'r' => $args['rating'],
+	);
+
+	if ( is_ssl() ) {
+		$url = 'https://secure.gravatar.com/avatar/' . $email_hash;
+	} else {
+		$url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+	}
+
+	$url = add_query_arg(
+		rawurlencode_deep( array_filter( $url_args ) ),
+		set_url_scheme( $url, $args['scheme'] )
+	);
+
+	/**
+	 * Filter the avatar URL.
+	 *
+	 * @since 4.2.0
+	 *
+	 * @param string            $url         The URL of the avatar.
+	 * @param int|object|string $id_or_email A user ID, email address, or 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 );
+
+	/**
+	 * Filter the avatar data.
+	 *
+	 * @since 4.2.0
+	 *
+	 * @param array             $args        Arguments passed to get_avatar_data(), after processing.
+	 * @param int|object|string $id_or_email A user ID, email address, or comment object.
+	 */
+	return apply_filters( 'get_avatar_data', $args, $id_or_email );
+}