X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/link-template.php diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php index 7a7b7874..9d7a5f6c 100644 --- a/wp-includes/link-template.php +++ b/wp-includes/link-template.php @@ -7,35 +7,42 @@ */ /** - * Display the permalink for the current post. + * Displays the permalink for the current post. * * @since 1.2.0 + * @since 4.4.0 Added the `$post` parameter. + * + * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. */ -function the_permalink() { +function the_permalink( $post = 0 ) { /** - * Filter the display of the permalink for the current post. + * Filters the display of the permalink for the current post. * * @since 1.5.0 + * @since 4.4.0 Added the `$post` parameter. * - * @param string $permalink The permalink for the current post. + * @param string $permalink The permalink for the current post. + * @param int|WP_Post $post Post ID, WP_Post object, or 0. Default 0. */ - echo esc_url( apply_filters( 'the_permalink', get_permalink() ) ); + echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) ); } /** - * Retrieve trailing slash string, if blog set for adding trailing slashes. + * Retrieves a trailing-slashed string if the site is set for adding trailing slashes. * * Conditionally adds a trailing slash if the permalink structure has a trailing * slash, strips the trailing slash if not. The string is passed through the - * 'user_trailingslashit' filter. Will remove trailing slash from string, if - * blog is not set to have them. + * {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if + * site is not set to have them. * * @since 2.2.0 - * @uses $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. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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. */ function user_trailingslashit($string, $type_of_url = '') { global $wp_rewrite; @@ -45,8 +52,7 @@ function user_trailingslashit($string, $type_of_url = '') { $string = untrailingslashit($string); /** - * Filter the trailing slashed string, depending on whether the site is set - * to use training slashes. + * Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes. * * @since 2.2.0 * @@ -55,19 +61,18 @@ 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 ); } /** - * Display permalink anchor for current post. + * Displays the permalink anchor for the current post. * * The permalink mode title will use the post title for the 'a' element 'id' * attribute. The id mode uses 'post-' with the post ID for the 'id' attribute. * * @since 0.71 * - * @param string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'. + * @param string $mode Optional. Permalink mode. Accepts 'title' or 'id'. Default 'id'. */ function permalink_anchor( $mode = 'id' ) { $post = get_post(); @@ -84,7 +89,7 @@ function permalink_anchor( $mode = 'id' ) { } /** - * Retrieve full permalink for current post or post ID. + * Retrieves the full permalink for the current post or post ID. * * This function is an alias for get_permalink(). * @@ -92,24 +97,25 @@ function permalink_anchor( $mode = 'id' ) { * * @see get_permalink() * - * @param int|WP_Post $id Optional. Post ID or post object. Default is the current post. + * @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|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 ); +function get_the_permalink( $post = 0, $leavename = false ) { + return get_permalink( $post, $leavename ); } /** - * Retrieve full permalink for current post or post ID. + * Retrieves the full permalink for the current post or post ID. * * @since 1.0.0 * - * @param int|WP_Post $id Optional. Post ID or post object. Default current post. + * @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|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 ) { +function get_permalink( $post = 0, $leavename = false ) { $rewritecode = array( '%year%', '%monthnum%', @@ -124,11 +130,10 @@ function get_permalink( $id = 0, $leavename = false ) { $leavename? '' : '%pagename%', ); - if ( is_object($id) && isset($id->filter) && 'sample' == $id->filter ) { - $post = $id; + if ( is_object( $post ) && isset( $post->filter ) && 'sample' == $post->filter ) { $sample = true; } else { - $post = get_post($id); + $post = get_post( $post ); $sample = false; } @@ -145,7 +150,7 @@ function get_permalink( $id = 0, $leavename = false ) { $permalink = get_option('permalink_structure'); /** - * Filter the permalink structure for a post before token replacement occurs. + * Filters the permalink structure for a post before token replacement occurs. * * Only applies to posts with post_type of 'post'. * @@ -157,7 +162,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 = ''; @@ -167,7 +172,7 @@ function get_permalink( $id = 0, $leavename = false ) { usort($cats, '_usort_terms_by_ID'); // order by ID /** - * Filter the category that gets used in the %category% permalink token. + * Filters the category that gets used in the %category% permalink token. * * @since 3.5.0 * @@ -186,7 +191,9 @@ function get_permalink( $id = 0, $leavename = false ) { // having to assign it explicitly if ( empty($category) ) { $default_category = get_term( get_option( 'default_category' ), 'category' ); - $category = is_wp_error( $default_category ) ? '' : $default_category->slug; + if ( $default_category && ! is_wp_error( $default_category ) ) { + $category = $default_category->slug; + } } } @@ -218,7 +225,7 @@ function get_permalink( $id = 0, $leavename = false ) { } /** - * Filter the permalink for a post. + * Filters the permalink for a post. * * Only applies to posts with post_type of 'post'. * @@ -232,14 +239,16 @@ function get_permalink( $id = 0, $leavename = false ) { } /** - * Retrieve the permalink for a post with a custom post type. + * Retrieves the permalink for a post of a custom post type. * * @since 3.0.0 * - * @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 + * @global WP_Rewrite $wp_rewrite + * + * @param int $id Optional. Post ID. Default uses the global `$post`. + * @param bool $leavename Optional, defaults to false. Whether to keep post name. Default false. + * @param bool $sample Optional, defaults to false. 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; @@ -253,14 +262,16 @@ 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 = get_post_status( $id ) && in_array( get_post_status( $id ), array( 'draft', 'pending', 'auto-draft', 'future' ) ); $post_type = get_post_type_object($post->post_type); + if ( $post_type->hierarchical ) { + $slug = get_page_uri( $id ); + } + if ( !empty($post_link) && ( !$draft_or_pending || $sample ) ) { if ( ! $leavename ) { - if ( $post_type->hierarchical ) - $slug = get_page_uri($id); $post_link = str_replace("%$post->post_type%", $slug, $post_link); } $post_link = home_url( user_trailingslashit($post_link) ); @@ -273,7 +284,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) { } /** - * Filter the permalink for a post with a custom post type. + * Filters the permalink for a post of a custom post type. * * @since 3.0.0 * @@ -286,32 +297,17 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) { } /** - * Retrieve permalink from post ID. - * - * @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 - */ -function post_permalink( $post_id = 0, $deprecated = '' ) { - if ( !empty( $deprecated ) ) - _deprecated_argument( __FUNCTION__, '1.3' ); - - return get_permalink($post_id); -} - -/** - * Retrieve the permalink for current page or page ID. + * Retrieves the permalink for the current page or page ID. * * Respects page_on_front. Use this one. * * @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. - * @return string + * @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. + * @return string The page permalink. */ function get_page_link( $post = false, $leavename = false, $sample = false ) { $post = get_post( $post ); @@ -322,7 +318,7 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) { $link = _get_page_link( $post, $leavename, $sample ); /** - * Filter the permalink for a page. + * Filters the permalink for a page. * * @since 1.5.0 * @@ -334,17 +330,20 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) { } /** - * Retrieve the page permalink. + * Retrieves the page permalink. * * Ignores page_on_front. Internal use only. * * @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. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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. + * @return string The page permalink. */ function _get_page_link( $post = false, $leavename = false, $sample = false ) { global $wp_rewrite; @@ -367,7 +366,7 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) { } /** - * Filter the permalink for a non-page_on_front page. + * Filters the permalink for a non-page_on_front page. * * @since 2.1.0 * @@ -378,15 +377,17 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) { } /** - * Retrieve permalink for attachment. + * Retrieves the permalink for an attachment. * * This can be used in the WordPress Loop or outside of it. * * @since 2.0.0 * - * @param int|object $post Optional. Post ID or object. - * @param bool $leavename Optional. Leave name. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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. */ function get_attachment_link( $post = null, $leavename = false ) { global $wp_rewrite; @@ -395,6 +396,9 @@ function get_attachment_link( $post = null, $leavename = 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() ) ) { + $parent = false; + } if ( $wp_rewrite->using_permalinks() && $parent ) { if ( 'page' == $parent->post_type ) @@ -412,13 +416,15 @@ function get_attachment_link( $post = null, $leavename = false ) { if ( ! $leavename ) $link = str_replace( '%postname%', $name, $link ); + } elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) { + $link = home_url( user_trailingslashit( $post->post_name ) ); } if ( ! $link ) $link = home_url( '/?attachment_id=' . $post->ID ); /** - * Filter the permalink for an attachment. + * Filters the permalink for an attachment. * * @since 2.0.0 * @@ -429,14 +435,16 @@ function get_attachment_link( $post = null, $leavename = false ) { } /** - * Retrieve the permalink for the year archives. + * Retrieves the permalink for the year archives. * * @since 1.5.0 * + * @global WP_Rewrite $wp_rewrite + * * @param int|bool $year False for current year or year for permalink. - * @return string + * @return string The permalink for the specified year archive. */ -function get_year_link($year) { +function get_year_link( $year ) { global $wp_rewrite; if ( !$year ) $year = gmdate('Y', current_time('timestamp')); @@ -449,7 +457,7 @@ function get_year_link($year) { } /** - * Filter the year archive permalink. + * Filters the year archive permalink. * * @since 1.5.0 * @@ -460,13 +468,15 @@ function get_year_link($year) { } /** - * Retrieve the permalink for the month archives with year. + * Retrieves the permalink for the month archives with 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 + * @return string The permalink for the specified month and year archive. */ function get_month_link($year, $month) { global $wp_rewrite; @@ -484,7 +494,7 @@ function get_month_link($year, $month) { } /** - * Filter the month archive permalink. + * Filters the month archive permalink. * * @since 1.5.0 * @@ -496,14 +506,16 @@ function get_month_link($year, $month) { } /** - * Retrieve the permalink for the day archives with year and month. + * Retrieves the permalink for the day archives with year and 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. - * @return string + * @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) { global $wp_rewrite; @@ -525,7 +537,7 @@ function get_day_link($year, $month, $day) { } /** - * Filter the day archive permalink. + * Filters the day archive permalink. * * @since 1.5.0 * @@ -538,18 +550,18 @@ function get_day_link($year, $month, $day) { } /** - * Display the permalink for the feed type. + * Displays the permalink for the feed type. * * @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. Feed type. Default empty. */ function the_feed_link( $anchor, $feed = '' ) { $link = '' . $anchor . ''; /** - * Filter the feed link anchor tag. + * Filters the feed link anchor tag. * * @since 3.0.0 * @@ -561,14 +573,16 @@ function the_feed_link( $anchor, $feed = '' ) { } /** - * Retrieve the permalink for the feed type. + * Retrieves the permalink for the feed type. * * @since 1.5.0 * - * @param string $feed Optional, defaults to default feed. Feed type. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @param string $feed Optional. Feed type. Default empty. + * @return string The feed permalink. */ -function get_feed_link($feed = '') { +function get_feed_link( $feed = '' ) { global $wp_rewrite; $permalink = $wp_rewrite->get_feed_permastruct(); @@ -595,7 +609,7 @@ function get_feed_link($feed = '') { } /** - * Filter the feed type permalink. + * Filters the feed type permalink. * * @since 1.5.0 * @@ -606,15 +620,15 @@ function get_feed_link($feed = '') { } /** - * Retrieve the permalink for the post comments feed. + * Retrieves the permalink for the post comments feed. * * @since 2.2.0 * - * @param int $post_id Optional. Post ID. - * @param string $feed Optional. Feed type. - * @return string + * @param int $post_id Optional. Post ID. Default is the ID of the global `$post`. + * @param string $feed Optional. Feed type. Default empty. + * @return string The permalink for the comments feed for the given post. */ -function get_post_comments_feed_link($post_id = 0, $feed = '') { +function get_post_comments_feed_link( $post_id = 0, $feed = '' ) { $post_id = absint( $post_id ); if ( ! $post_id ) @@ -623,26 +637,39 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') { if ( empty( $feed ) ) $feed = get_default_feed(); + $post = get_post( $post_id ); + $unattached = 'attachment' === $post->post_type && 0 === (int) $post->post_parent; + if ( '' != get_option('permalink_structure') ) { if ( 'page' == get_option('show_on_front') && $post_id == get_option('page_on_front') ) $url = _get_page_link( $post_id ); else $url = get_permalink($post_id); - $url = trailingslashit($url) . 'feed'; - if ( $feed != get_default_feed() ) - $url .= "/$feed"; - $url = user_trailingslashit($url, 'single_feed'); + if ( $unattached ) { + $url = home_url( '/feed/' ); + if ( $feed !== get_default_feed() ) { + $url .= "$feed/"; + } + $url = add_query_arg( 'attachment_id', $post_id, $url ); + } else { + $url = trailingslashit($url) . 'feed'; + if ( $feed != get_default_feed() ) + $url .= "/$feed"; + $url = user_trailingslashit($url, 'single_feed'); + } } else { - $type = get_post_field('post_type', $post_id); - if ( 'page' == $type ) + if ( $unattached ) { + $url = add_query_arg( array( 'feed' => $feed, 'attachment_id' => $post_id ), home_url( '/' ) ); + } elseif ( 'page' == $post->post_type ) { $url = add_query_arg( array( 'feed' => $feed, 'page_id' => $post_id ), home_url( '/' ) ); - else + } else { $url = add_query_arg( array( 'feed' => $feed, 'p' => $post_id ), home_url( '/' ) ); + } } /** - * Filter the post comments feed permalink. + * Filters the post comments feed permalink. * * @since 1.5.1 * @@ -652,7 +679,7 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') { } /** - * Display the comment feed link for a post. + * Displays the comment feed link for a post. * * Prints out the comment feed link for a post. Link text is placed in the * anchor. If no link text is specified, default text is used. If no post ID is @@ -660,18 +687,19 @@ 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 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. + */ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { - $url = esc_url( get_post_comments_feed_link( $post_id, $feed ) ); - if ( empty($link_text) ) + $url = get_post_comments_feed_link( $post_id, $feed ); + if ( empty( $link_text ) ) { $link_text = __('Comments Feed'); + } + $link = '' . $link_text . ''; /** - * Filter the post comment feed link anchor tag. + * Filters the post comment feed link anchor tag. * * @since 2.8.0 * @@ -679,21 +707,21 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { * @param int $post_id Post ID. * @param string $feed The feed type, or an empty string for the default feed type. */ - echo apply_filters( 'post_comments_feed_link_html', "$link_text", $post_id, $feed ); + echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed ); } /** - * Retrieve the feed link for a given author. + * Retrieves the feed link for a given author. * * Returns a link to the feed for all posts by a given author. A specific feed * can be requested or left blank to get the default feed. * * @since 2.5.0 * - * @param int $author_id ID of an author. - * @param string $feed Optional. Feed type. + * @param int $author_id Author ID. + * @param string $feed Optional. Feed type. Default empty. * @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'); @@ -714,7 +742,7 @@ function get_author_feed_link( $author_id, $feed = '' ) { } /** - * Filter the feed link for a given author. + * Filters the feed link for a given author. * * @since 1.5.1 * @@ -727,34 +755,34 @@ function get_author_feed_link( $author_id, $feed = '' ) { } /** - * Retrieve the feed link for a category. + * Retrieves the feed link for a category. * * Returns a link to the feed for all posts in a given category. A specific feed * can be requested or left blank to get the default feed. * * @since 2.5.0 * - * @param int $cat_id ID of a category. - * @param string $feed Optional. Feed type. + * @param int $cat_id Category ID. + * @param string $feed Optional. Feed type. Default empty. * @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 ); } /** - * Retrieve the feed link for a term. + * Retrieves the feed link for a term. * * Returns a link to the feed for all posts in a given term. A specific feed * can be requested or left blank to get the default feed. * * @since 3.0.0 * - * @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 int $term_id Term ID. + * @param string $taxonomy Optional. Taxonomy of `$term_id`. Default 'category'. + * @param string $feed Optional. Feed type. Default empty. + * @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; @@ -790,7 +818,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { if ( 'category' == $taxonomy ) { /** - * Filter the category feed link. + * Filters the category feed link. * * @since 1.5.1 * @@ -800,7 +828,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { $link = apply_filters( 'category_feed_link', $link, $feed ); } elseif ( 'post_tag' == $taxonomy ) { /** - * Filter the post tag feed link. + * Filters the post tag feed link. * * @since 2.3.0 * @@ -810,7 +838,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { $link = apply_filters( 'tag_feed_link', $link, $feed ); } else { /** - * Filter the feed link for a taxonomy other than 'category' or 'post_tag'. + * Filters the feed link for a taxonomy other than 'category' or 'post_tag'. * * @since 3.0.0 * @@ -825,30 +853,30 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { } /** - * Retrieve permalink for feed of tag. + * Retrieves the permalink for a tag feed. * * @since 2.3.0 * - * @param int $tag_id Tag ID. - * @param string $feed Optional. Feed type. - * @return string + * @param int $tag_id Tag ID. + * @param string $feed Optional. Feed type. Default empty. + * @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 ); } /** - * Retrieve edit tag link. + * Retrieves the edit link for a tag. * * @since 2.7.0 * - * @param int $tag_id Tag ID - * @param string $taxonomy Taxonomy - * @return string + * @param int $tag_id Tag ID. + * @param string $taxonomy Optional. Taxonomy slug. Default 'post_tag'. + * @return string The edit tag link URL for the given tag. */ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) { /** - * Filter the edit link for a tag (or term in another taxonomy). + * Filters the edit link for a tag (or term in another taxonomy). * * @since 2.7.0 * @@ -858,21 +886,21 @@ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) { } /** - * Display or retrieve edit tag link with formatting. + * Displays or retrieves the edit link for a tag with formatting. * * @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 object $tag Tag 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 WP_Term $tag Optional. Term object. If null, the queried object will be inspected. + * Default null. */ function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) { $link = edit_term_link( $link, '', '', $tag, false ); /** - * Filter the anchor tag for the edit link for a tag (or term in another taxonomy). + * Filters the anchor tag for the edit link for a tag (or term in another taxonomy). * * @since 2.7.0 * @@ -882,35 +910,49 @@ function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) { } /** - * Retrieve edit term url. + * Retrieves the URL for editing a given term. * * @since 3.1.0 + * @since 4.5.0 The `$taxonomy` argument was made optional. * - * @param int $term_id Term ID - * @param string $taxonomy Taxonomy - * @param string $object_type The object type - * @return string + * @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 + * 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 ) ) +function get_edit_term_link( $term_id, $taxonomy = '', $object_type = '' ) { + $term = get_term( $term_id, $taxonomy ); + if ( ! $term || is_wp_error( $term ) ) { return; + } - $term = get_term( $term_id, $taxonomy ); + $tax = get_taxonomy( $term->taxonomy ); + if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) { + return; + } $args = array( - 'action' => 'edit', 'taxonomy' => $taxonomy, - 'tag_ID' => $term->term_id, + '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' ) ); + if ( $tax->show_ui ) { + $location = add_query_arg( $args, admin_url( 'term.php' ) ); + } else { + $location = ''; + } /** - * Filter the edit link for a term. + * Filters the edit link for a term. * * @since 3.1.0 * @@ -923,15 +965,16 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) { } /** - * Display or retrieve edit term link with formatting. + * Displays or retrieves the edit term link with formatting. * * @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 ) ) @@ -950,7 +993,7 @@ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $e $link = '' . $link . ''; /** - * Filter the anchor tag for the edit link of a term. + * Filters the anchor tag for the edit link of a term. * * @since 3.1.0 * @@ -966,12 +1009,14 @@ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $e } /** - * Retrieve permalink for search. + * Retrieves the permalink for a search. * * @since 3.0.0 * - * @param string $query Optional. The query string to use. If empty the current query is used. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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 = '' ) { global $wp_rewrite; @@ -987,13 +1032,13 @@ function get_search_link( $query = '' ) { $link = home_url('?s=' . urlencode($search) ); } else { $search = urlencode($search); - $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it unencoded. + $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it un-encoded. $link = str_replace( '%search%', $search, $permastruct ); $link = home_url( user_trailingslashit( $link, 'search' ) ); } /** - * Filter the search permalink. + * Filters the search permalink. * * @since 3.0.0 * @@ -1004,13 +1049,15 @@ function get_search_link( $query = '' ) { } /** - * Retrieve the permalink for the feed of the search results. + * Retrieves the permalink for the search results feed. * * @since 2.5.0 * - * @param string $search_query Optional. Search query. - * @param string $feed Optional. Feed type. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @param string $search_query Optional. Search query. Default empty. + * @param string $feed Optional. Feed type. Default empty. + * @return string The search results feed permalink. */ function get_search_feed_link($search_query = '', $feed = '') { global $wp_rewrite; @@ -1029,7 +1076,7 @@ function get_search_feed_link($search_query = '', $feed = '') { } /** - * Filter the search feed link. + * Filters the search feed link. * * @since 2.5.0 * @@ -1037,19 +1084,19 @@ 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' ); } /** - * Retrieve the permalink for the comments feed of the search results. + * Retrieves the permalink for the search results comments feed. * * @since 2.5.0 * - * @param string $search_query Optional. Search query. - * @param string $feed Optional. Feed type. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @param string $search_query Optional. Search query. Default empty. + * @param string $feed Optional. Feed type. Default empty. + * @return string The comments feed search results permalink. */ function get_search_comments_feed_link($search_query = '', $feed = '') { global $wp_rewrite; @@ -1067,24 +1114,38 @@ 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' ); } /** - * Retrieve the permalink for a post type archive. + * Retrieves the permalink for a post type archive. * * @since 3.1.0 + * @since 4.5.0 Support for posts was added. * - * @param string $post_type Post type - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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 ) ) 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 ) { + $link = get_permalink( $page_for_posts ); + } else { + $link = get_home_url(); + } + /** This filter is documented in wp-includes/link-template.php */ + return apply_filters( 'post_type_archive_link', $link, $post_type ); + } + if ( ! $post_type_obj->has_archive ) return false; @@ -1100,7 +1161,7 @@ function get_post_type_archive_link( $post_type ) { } /** - * Filter the post type archive permalink. + * Filters the post type archive permalink. * * @since 3.1.0 * @@ -1111,13 +1172,13 @@ function get_post_type_archive_link( $post_type ) { } /** - * Retrieve the permalink for a post type archive feed. + * 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 - * @return string + * @param string $feed Optional. Feed type. Default empty. + * @return string|false The post type feed permalink. */ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { $default_feed = get_default_feed(); @@ -1138,7 +1199,7 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { } /** - * Filter the post type archive feed link. + * Filters the post type archive feed link. * * @since 3.1.0 * @@ -1149,16 +1210,59 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { } /** - * Retrieve edit posts link for post. + * Retrieves the URL used for the post preview. + * + * Allows additional query args to be appended. + * + * @since 4.4.0 + * + * @param int|WP_Post $post Optional. Post ID or `WP_Post` object. Defaults to global `$post`. + * @param array $query_args Optional. Array of additional query args to be appended to the link. + * Default empty array. + * @param string $preview_link Optional. Base preview link to be used if it should differ from the + * post permalink. Default empty. + * @return string|null URL used for the post preview, or null if the post does not exist. + */ +function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) { + $post = get_post( $post ); + if ( ! $post ) { + return; + } + + $post_type_object = get_post_type_object( $post->post_type ); + if ( is_post_type_viewable( $post_type_object ) ) { + if ( ! $preview_link ) { + $preview_link = set_url_scheme( get_permalink( $post ) ); + } + + $query_args['preview'] = 'true'; + $preview_link = add_query_arg( $query_args, $preview_link ); + } + + /** + * Filters the URL used for a post preview. + * + * @since 2.0.5 + * @since 4.0.0 Added the `$post` parameter. + * + * @param string $preview_link URL used for the post preview. + * @param WP_Post $post Post object. + */ + return apply_filters( 'preview_post_link', $preview_link, $post ); +} + +/** + * Retrieves the edit post link for post. * * Can be used within the WordPress loop or outside of it. Can be used with * pages, posts, attachments, and revisions. * * @since 2.3.0 * - * @param int $id Optional. Post ID. - * @param string $context Optional, defaults to display. How to write the '&', defaults to '&'. - * @return string + * @param int $id Optional. Post ID. Default is the ID of the global `$post`. + * @param string $context Optional. How to output the '&' character. Default '&'. + * @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 ) ) @@ -1178,8 +1282,14 @@ function get_edit_post_link( $id = 0, $context = 'display' ) { if ( !current_user_can( 'edit_post', $post->ID ) ) return; + if ( $post_type_object->_edit_link ) { + $link = admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ); + } else { + $link = ''; + } + /** - * Filter the post edit link. + * Filters the post edit link. * * @since 2.3.0 * @@ -1188,20 +1298,22 @@ function get_edit_post_link( $id = 0, $context = 'display' ) { * @param string $context The link context. If set to 'display' then ampersands * are encoded. */ - return apply_filters( 'get_edit_post_link', admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ), $post->ID, $context ); + return apply_filters( 'get_edit_post_link', $link, $post->ID, $context ); } /** - * Display edit post link for post. + * Displays the edit post link for post. * * @since 1.0.0 + * @since 4.4.0 The `$class` argument was added. * - * @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 $text Optional. Anchor text. If null, default is 'Edit This'. Default null. + * @param string $before Optional. Display before edit link. Default empty. + * @param string $after Optional. Display after edit link. Default empty. + * @param int $id Optional. Post ID. Default is the ID of 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 ) { +function edit_post_link( $text = null, $before = '', $after = '', $id = 0, $class = 'post-edit-link' ) { if ( ! $post = get_post( $id ) ) { return; } @@ -1214,10 +1326,10 @@ function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) { $text = __( 'Edit This' ); } - $link = '' . $text . ''; + $link = '' . $text . ''; /** - * Filter the post edit link anchor tag. + * Filters the post edit link anchor tag. * * @since 2.3.0 * @@ -1229,20 +1341,20 @@ function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) { } /** - * Retrieve delete posts link for post. + * Retrieves the delete posts link for post. * * Can be used within the WordPress loop or outside of it, with any post type. * * @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 + * @param int $id Optional. Post ID. Default is the ID of the global `$post`. + * @param string $deprecated Not used. + * @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' ); + _deprecated_argument( __FUNCTION__, '3.0.0' ); if ( !$post = get_post( $id ) ) return; @@ -1259,7 +1371,7 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) ); /** - * Filter the post delete link. + * Filters the post delete link. * * @since 2.9.0 * @@ -1271,12 +1383,12 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false } /** - * Retrieve edit comment link. + * Retrieves the edit comment link. * * @since 2.3.0 * - * @param int $comment_id Optional. Comment ID. - * @return string + * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. + * @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 ); @@ -1287,7 +1399,7 @@ function get_edit_comment_link( $comment_id = 0 ) { $location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID; /** - * Filter the comment edit link. + * Filters the comment edit link. * * @since 2.3.0 * @@ -1297,16 +1409,16 @@ function get_edit_comment_link( $comment_id = 0 ) { } /** - * Display edit comment link with formatting. + * Displays the edit comment link with formatting. * * @since 1.0.0 * - * @param string $text Optional. Anchor text. - * @param string $before Optional. Display before edit link. - * @param string $after Optional. Display after edit link. + * @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. + * @param string $before Optional. Display before edit link. Default empty. + * @param string $after Optional. Display after edit link. Default empty. */ function edit_comment_link( $text = null, $before = '', $after = '' ) { - global $comment; + $comment = get_comment(); if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { return; @@ -1316,10 +1428,10 @@ function edit_comment_link( $text = null, $before = '', $after = '' ) { $text = __( 'Edit This' ); } - $link = '' . $text . ''; + $link = '' . $text . ''; /** - * Filter the comment edit link anchor tag. + * Filters the comment edit link anchor tag. * * @since 2.3.0 * @@ -1331,12 +1443,12 @@ function edit_comment_link( $text = null, $before = '', $after = '' ) { } /** - * Display edit bookmark (literally a URL external to blog) link. + * Displays the edit bookmark link. * * @since 2.7.0 * - * @param int $link Optional. Bookmark ID. - * @return string + * @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 ); @@ -1347,7 +1459,7 @@ function get_edit_bookmark_link( $link = 0 ) { $location = admin_url('link.php?action=edit&link_id=') . $link->link_id; /** - * Filter the bookmark (link) edit link. + * Filters the bookmark edit link. * * @since 2.7.0 * @@ -1358,14 +1470,14 @@ function get_edit_bookmark_link( $link = 0 ) { } /** - * Display edit bookmark (literally a URL external to blog) link anchor content. + * Displays the edit bookmark link anchor content. * * @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. 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 ) { $bookmark = get_bookmark($bookmark); @@ -1376,10 +1488,10 @@ function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = if ( empty($link) ) $link = __('Edit This'); - $link = '' . $link . ''; + $link = '' . $link . ''; /** - * Filter the bookmark edit link anchor tag. + * Filters the bookmark edit link anchor tag. * * @since 2.7.0 * @@ -1390,7 +1502,7 @@ function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = } /** - * Retrieve edit user link + * Retrieves the edit user link. * * @since 3.5.0 * @@ -1415,7 +1527,7 @@ function get_edit_user_link( $user_id = null ) { $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) ); /** - * Filter the user edit link. + * Filters the user edit link. * * @since 3.5.0 * @@ -1428,45 +1540,50 @@ function get_edit_user_link( $user_id = null ) { // Navigation links /** - * Retrieve previous post that is adjacent to current post. + * Retrieves the previous post that is adjacent to the current post. * * @since 1.5.0 * - * @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 $in_same_term Optional. Whether post should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @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 ); } /** - * Retrieve next post that is adjacent to current post. + * Retrieves the next post that is adjacent to the current post. * * @since 1.5.0 * - * @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 $in_same_term Optional. Whether post should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @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 ); } /** - * Retrieve adjacent post. + * Retrieves the adjacent post. * * Can either be next or previous post. * * @since 2.5.0 * - * @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. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. + * @param bool $previous Optional. Whether to retrieve previous post. Default true * @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; @@ -1478,15 +1595,13 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo $join = ''; $where = ''; + $adjacent = $previous ? 'previous' : 'next'; if ( $in_same_term || ! empty( $excluded_terms ) ) { - $join = " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id"; - $where = $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy ); - if ( ! empty( $excluded_terms ) && ! is_array( $excluded_terms ) ) { // back-compat, $excluded_terms used to be $excluded_terms with IDs separated by " and " if ( false !== strpos( $excluded_terms, ' and ' ) ) { - _deprecated_argument( __FUNCTION__, '3.3', sprintf( __( 'Use commas instead of %s to separate excluded terms.' ), "'and'" ) ); + _deprecated_argument( __FUNCTION__, '3.3.0', sprintf( __( 'Use commas instead of %s to separate excluded terms.' ), "'and'" ) ); $excluded_terms = explode( ' and ', $excluded_terms ); } else { $excluded_terms = explode( ',', $excluded_terms ); @@ -1496,6 +1611,9 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo } if ( $in_same_term ) { + $join .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id"; + $where .= $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy ); + if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) ) return ''; $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); @@ -1510,54 +1628,103 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo $where .= " AND tt.term_id IN (" . implode( ',', $term_array ) . ")"; } + /** + * Filters the IDs of terms excluded from adjacent post queries. + * + * The dynamic portion of the hook name, `$adjacent`, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 4.4.0 + * + * @param string $excluded_terms Array of excluded term IDs. + */ + $excluded_terms = apply_filters( "get_{$adjacent}_post_excluded_terms", $excluded_terms ); + if ( ! empty( $excluded_terms ) ) { - $where .= " AND p.ID NOT IN ( SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id IN (" . implode( $excluded_terms, ',' ) . ') )'; + $where .= " AND p.ID NOT IN ( SELECT tr.object_id FROM $wpdb->term_relationships tr LEFT JOIN $wpdb->term_taxonomy tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) WHERE tt.term_id IN (" . implode( ',', array_map( 'intval', $excluded_terms ) ) . ') )'; } } - $adjacent = $previous ? 'previous' : 'next'; + // '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'"; + } + $op = $previous ? '<' : '>'; $order = $previous ? 'DESC' : 'ASC'; /** - * Filter the JOIN clause in the SQL for an adjacent post query. + * Filters the JOIN clause in the SQL for an adjacent post query. * - * The dynamic portion of the hook name, $adjacent, refers to the type + * The dynamic portion of the hook name, `$adjacent`, refers to the type * of adjacency, 'next' or 'previous'. * * @since 2.5.0 + * @since 4.4.0 Added the `$taxonomy` and `$post` parameters. * - * @param string $join The JOIN clause in the SQL. - * @param bool $in_same_term Whether post should be in a same taxonomy term. - * @param array $excluded_terms Array of excluded term IDs. + * @param string $join The JOIN clause in the SQL. + * @param bool $in_same_term Whether post should be in a same taxonomy term. + * @param array $excluded_terms Array of excluded term IDs. + * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. + * @param WP_Post $post WP_Post object. */ - $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms ); + $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post ); /** - * Filter the WHERE clause in the SQL for an adjacent post query. + * Filters the WHERE clause in the SQL for an adjacent post query. * - * The dynamic portion of the hook name, $adjacent, refers to the type + * The dynamic portion of the hook name, `$adjacent`, refers to the type * of adjacency, 'next' or 'previous'. * * @since 2.5.0 + * @since 4.4.0 Added the `$taxonomy` and `$post` parameters. * - * @param string $where The WHERE clause in the SQL. + * @param string $where The `WHERE` clause in the SQL. * @param bool $in_same_term Whether post should be in a same taxonomy term. * @param array $excluded_terms Array of excluded term IDs. + * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. + * @param WP_Post $post WP_Post object. */ - $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, $taxonomy, $post ); /** - * Filter the ORDER BY clause in the SQL for an adjacent post query. + * Filters the ORDER BY clause in the SQL for an adjacent post query. * - * The dynamic portion of the hook name, $adjacent, refers to the type + * The dynamic portion of the hook name, `$adjacent`, refers to the type * of adjacency, 'next' or 'previous'. * * @since 2.5.0 + * @since 4.4.0 Added the `$post` parameter. * - * @param string $order_by The ORDER BY clause in the SQL. + * @param string $order_by The `ORDER BY` clause in the SQL. + * @param WP_Post $post WP_Post object. */ - $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" ); + $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1", $post ); $query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort"; $query_key = 'adjacent_post_' . md5( $query ); @@ -1581,18 +1748,18 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo } /** - * Get adjacent post relational link. + * Retrieves the adjacent post relational link. * * Can either be next or previous post relational link. * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $title Optional. Link title format. Default '%title'. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @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 + * @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() ) @@ -1620,9 +1787,9 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $ $adjacent = $previous ? 'previous' : 'next'; /** - * Filter the adjacent post relational link. + * Filters the adjacent post relational link. * - * The dynamic portion of the hook name, $adjacent, refers to the type + * The dynamic portion of the hook name, `$adjacent`, refers to the type * of adjacency, 'next' or 'previous'. * * @since 2.8.0 @@ -1633,13 +1800,13 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $ } /** - * Display relational links for the posts adjacent to the current post. + * Displays the relational links for the posts adjacent to the current post. * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $title Optional. Link title format. Default '%title'. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { @@ -1648,11 +1815,14 @@ function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $exc } /** - * Display relational links for the posts adjacent to the current post for single post pages. + * Displays relational links for the posts adjacent to the current post for single post pages. + * + * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins + * or theme templates. * - * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates. * @since 3.0.0 * + * @see adjacent_posts_rel_link() */ function adjacent_posts_rel_link_wp_head() { if ( ! is_single() || is_attachment() ) { @@ -1662,13 +1832,15 @@ function adjacent_posts_rel_link_wp_head() { } /** - * Display relational link for the next post adjacent to the current post. + * Displays the relational link for the next post adjacent to the current post. * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @see get_adjacent_post_rel_link() + * + * @param string $title Optional. Link title format. Default '%title'. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { @@ -1676,12 +1848,14 @@ function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded } /** - * Display relational link for the previous post adjacent to the current post. + * Displays the relational link for the previous post adjacent to the current post. * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. + * @see get_adjacent_post_rel_link() + * + * @param string $title Optional. Link title format. Default '%title'. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default true. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ @@ -1690,7 +1864,7 @@ function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded } /** - * Retrieve boundary post. + * Retrieves the boundary post. * * Boundary being either the first or last post by publish date within the constraints specified * by $in_same_term or $excluded_terms. @@ -1698,10 +1872,12 @@ function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded * @since 2.8.0 * * @param bool $in_same_term Optional. Whether returned post should be in a same taxonomy term. + * Default false. * @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. + * Default empty. + * @param bool $start Optional. Whether to retrieve first or last post. Default true * @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(); @@ -1747,32 +1923,33 @@ function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start return get_posts( $query_args ); } -/* - * Get previous post link that is adjacent to the current post. +/** + * Retrieves the previous post link that is adjacent to the current post. * * @since 3.7.0 * - * @param string $format Optional. Link anchor format. - * @param string $link Optional. Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $format Optional. Link anchor format. Default '« %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. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. - * @return string + * @return string The link URL of the previous post in relation to the current post. */ function get_previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, true, $taxonomy ); } /** - * Display previous post link that is adjacent to the current post. + * Displays the previous post link that is adjacent to the current post. * * @since 1.5.0 + * * @see get_previous_post_link() * - * @param string $format Optional. Link anchor format. - * @param string $link Optional. Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $format Optional. Link anchor format. Default '« %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. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { @@ -1780,31 +1957,31 @@ function previous_post_link( $format = '« %link', $link = '%title', $in_sa } /** - * Get next post link that is adjacent to the current post. + * Retrieves the next post link that is adjacent to the current post. * * @since 3.7.0 * - * @param string $format Optional. Link anchor format. - * @param string $link Optional. Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $format Optional. Link anchor format. Default '« %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. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. - * @return string + * @return string The link URL of the next post in relation to the current post. */ function get_next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, false, $taxonomy ); } /** - * Display next post link that is adjacent to the current post. + * 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. - * @param string $link Optional. Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $format Optional. Link anchor format. Default '« %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. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty. * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { @@ -1812,7 +1989,7 @@ function next_post_link( $format = '%link »', $link = '%title', $in_same_t } /** - * Get adjacent post link. + * Retrieves the adjacent post link. * * Can be either next post link or previous. * @@ -1820,11 +1997,11 @@ function next_post_link( $format = '%link »', $link = '%title', $in_same_t * * @param string $format Link anchor format. * @param string $link Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. Default empty. * @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 + * @return string The link URL of the previous or next post in relation to the current post. */ function get_adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { if ( $previous && is_attachment() ) @@ -1857,50 +2034,52 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude $adjacent = $previous ? 'previous' : 'next'; /** - * Filter the adjacent post link. + * Filters the adjacent post link. * - * The dynamic portion of the hook name, $adjacent, refers to the type + * The dynamic portion of the hook name, `$adjacent`, refers to the type * 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 ); } /** - * Display adjacent post link. + * Displays the adjacent post link. * * Can be either next post link or previous. * * @since 2.5.0 - * @uses get_adjacent_post_link() * * @param string $format Link anchor format. * @param string $link Link permalink format. - * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. - * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. + * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. Default empty. * @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 */ function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy ); } /** - * Retrieve links for page numbers. + * Retrieves the link for a page number. * * @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(). - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @param int $pagenum Optional. Page ID. 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. */ function get_pagenum_link($pagenum = 1, $escape = true ) { global $wp_rewrite; @@ -1952,7 +2131,7 @@ function get_pagenum_link($pagenum = 1, $escape = true ) { } /** - * Filter the page number link for the current request. + * Filters the page number link for the current request. * * @since 2.5.0 * @@ -1967,14 +2146,16 @@ function get_pagenum_link($pagenum = 1, $escape = true ) { } /** - * Retrieve next posts page link. + * Retrieves the next posts page link. * * Backported from 2.1.3 to 2.0.10. * * @since 2.0.10 * - * @param int $max_page Optional. Max pages. - * @return string + * @global int $paged + * + * @param int $max_page Optional. Max pages. Default 0. + * @return string|void The link URL for next posts page. */ function get_next_posts_page_link($max_page = 0) { global $paged; @@ -1989,12 +2170,13 @@ function get_next_posts_page_link($max_page = 0) { } /** - * Display or return the next posts page link. + * Displays or retrieves the next posts page link. * * @since 0.71 * - * @param int $max_page Optional. Max pages. - * @param boolean $echo Optional. Echo or return; + * @param int $max_page Optional. Max pages. Default 0. + * @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 ) ); @@ -2006,13 +2188,16 @@ function next_posts( $max_page = 0, $echo = true ) { } /** - * Return the next posts page link. + * Retrieves the next posts page link. * * @since 2.7.0 * - * @param string $label Content for link text. - * @param int $max_page Optional. Max pages. - * @return string|null + * @global int $paged + * @global WP_Query $wp_query + * + * @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. */ function get_next_posts_link( $label = null, $max_page = 0 ) { global $paged, $wp_query; @@ -2030,7 +2215,7 @@ function get_next_posts_link( $label = null, $max_page = 0 ) { if ( !is_single() && ( $nextpage <= $max_page ) ) { /** - * Filter the anchor tag attributes for the next posts page link. + * Filters the anchor tag attributes for the next posts page link. * * @since 2.7.0 * @@ -2043,20 +2228,19 @@ function get_next_posts_link( $label = null, $max_page = 0 ) { } /** - * Display the next posts page link. + * Displays the next posts page link. * * @since 0.71 - * @uses get_next_posts_link() * - * @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. Default 0. */ function next_posts_link( $label = null, $max_page = 0 ) { echo get_next_posts_link( $label, $max_page ); } /** - * Retrieve previous posts page link. + * Retrieves the previous posts page link. * * Will only return string, if not on a single page or post. * @@ -2064,7 +2248,9 @@ function next_posts_link( $label = null, $max_page = 0 ) { * * @since 2.0.10 * - * @return string|null + * @global int $paged + * + * @return string|void The link for the previous posts page. */ function get_previous_posts_page_link() { global $paged; @@ -2078,11 +2264,12 @@ function get_previous_posts_page_link() { } /** - * Display or return the previous posts page link. + * Displays or retrieves the previous posts page link. * * @since 0.71 * - * @param boolean $echo Optional. Echo or return; + * @param bool $echo Optional. Whether to echo the link. Default true. + * @return string|void The previous posts page link if `$echo = false`. */ function previous_posts( $echo = true ) { $output = esc_url( get_previous_posts_page_link() ); @@ -2094,12 +2281,14 @@ function previous_posts( $echo = true ) { } /** - * Return the previous posts page link. + * Retrieves the previous posts page link. * * @since 2.7.0 * + * @global int $paged + * * @param string $label Optional. Previous page link text. - * @return string|null + * @return string|void HTML-formatted previous page link. */ function get_previous_posts_link( $label = null ) { global $paged; @@ -2109,7 +2298,7 @@ function get_previous_posts_link( $label = null ) { if ( !is_single() && $paged > 1 ) { /** - * Filter the anchor tag attributes for the previous posts page link. + * Filters the anchor tag attributes for the previous posts page link. * * @since 2.7.0 * @@ -2121,10 +2310,9 @@ function get_previous_posts_link( $label = null ) { } /** - * Display the previous posts page link. + * Displays the previous posts page link. * * @since 0.71 - * @uses get_previous_posts_link() * * @param string $label Optional. Previous page link text. */ @@ -2133,11 +2321,21 @@ function previous_posts_link( $label = null ) { } /** - * Return post pages link navigation for previous and next pages. + * Retrieves the post pages link navigation for previous and next pages. * * @since 2.8.0 * - * @param string|array $args Optional args. + * @global WP_Query $wp_query + * + * @param string|array $args { + * Optional. Arguments to build the post pages link navigation. + * + * @type string $sep Separator character. Default '—'. + * @type string $prelabel Link text to display for the previous page link. + * Default '« Previous Page'. + * @type string $nxtlabel Link text to display for the next page link. + * Default 'Next Page »'. + * } * @return string The posts link navigation. */ function get_posts_nav_link( $args = array() ) { @@ -2172,13 +2370,13 @@ function get_posts_nav_link( $args = array() ) { } /** - * Display post pages link navigation for previous and next pages. + * Displays the post pages link navigation for previous and next pages. * * @since 0.71 * - * @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. + * @param string $sep Optional. Separator for posts navigation links. Default empty. + * @param string $prelabel Optional. Label for previous pages. Default empty. + * @param string $nxtlabel Optional Label for next pages. Default empty. */ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { $args = array_filter( compact('sep', 'prelabel', 'nxtlabel') ); @@ -2186,12 +2384,238 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { } /** - * Retrieve comments page number link. + * 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. + * + * @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'. + * } + * @return string Markup for post links. + */ +function get_the_post_navigation( $args = array() ) { + $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' ), + ) ); + + $navigation = ''; + + $previous = get_previous_post_link( + '
%link
', + $args['prev_text'], + $args['in_same_term'], + $args['excluded_terms'], + $args['taxonomy'] + ); + + $next = get_next_post_link( + '
%link
', + $args['next_text'], + $args['in_same_term'], + $args['excluded_terms'], + $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'] ); + } + + return $navigation; +} + +/** + * Displays the navigation to next/previous post, when applicable. + * + * @since 4.1.0 + * + * @param array $args Optional. See get_the_post_navigation() for available arguments. + * Default empty array. + */ +function the_post_navigation( $args = array() ) { + echo get_the_post_navigation( $args ); +} + +/** + * Returns the navigation to next/previous set of posts, when applicable. + * + * @since 4.1.0 + * + * @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. + * 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 ) { + $args = wp_parse_args( $args, array( + 'prev_text' => __( 'Older posts' ), + 'next_text' => __( 'Newer posts' ), + 'screen_reader_text' => __( 'Posts navigation' ), + ) ); + + $next_link = get_previous_posts_link( $args['next_text'] ); + $prev_link = get_next_posts_link( $args['prev_text'] ); + + if ( $prev_link ) { + $navigation .= '
' . $prev_link . '
'; + } + + if ( $next_link ) { + $navigation .= '
' . $next_link . '
'; + } + + $navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] ); + } + + return $navigation; +} + +/** + * Displays the navigation to next/previous set of posts, when applicable. + * + * @since 4.1.0 + * + * @param array $args Optional. See get_the_posts_navigation() for available arguments. + * Default empty array. + */ +function the_posts_navigation( $args = array() ) { + echo get_the_posts_navigation( $args ); +} + +/** + * Retrieves a paginated navigation to next/previous set of posts, when applicable. + * + * @since 4.1.0 + * + * @param array $args { + * Optional. Default pagination arguments, see paginate_links(). + * + * @type string $screen_reader_text Screen reader text for navigation element. + * Default 'Posts navigation'. + * } + * @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 ) { + $args = wp_parse_args( $args, array( + 'mid_size' => 1, + 'prev_text' => _x( 'Previous', 'previous post' ), + 'next_text' => _x( 'Next', 'next post' ), + 'screen_reader_text' => __( 'Posts navigation' ), + ) ); + + // Make sure we get a string back. Plain is the next best thing. + 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'] ); + } + } + + return $navigation; +} + +/** + * Displays a paginated navigation to next/previous set of posts, when applicable. + * + * @since 4.1.0 + * + * @param array $args Optional. See get_the_posts_pagination() for available arguments. + * Default empty array. + */ +function the_posts_pagination( $args = array() ) { + echo get_the_posts_pagination( $args ); +} + +/** + * Wraps passed links in navigational markup. + * + * @since 4.1.0 + * @access private + * + * @param string $links Navigational links. + * @param string $class Optional. Custom class for nav element. Default: 'posts-navigation'. + * @param string $screen_reader_text Optional. Screen reader text for nav element. Default: 'Posts navigation'. + * @return string Navigation template tag. + */ +function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) { + if ( empty( $screen_reader_text ) ) { + $screen_reader_text = __( 'Posts navigation' ); + } + + $template = ' + '; + + /** + * 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 + * navigation links (%3$s): + * + * + * + * @since 4.4.0 + * + * @param string $template The default template. + * @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 ); +} + +/** + * Retrieves the comments page number link. * * @since 2.7.0 * - * @param int $pagenum Optional. Page number. - * @return string + * @global WP_Rewrite $wp_rewrite + * + * @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. */ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { global $wp_rewrite; @@ -2203,13 +2627,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 ); } @@ -2217,34 +2641,38 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { $result .= '#comments'; /** - * Filter the comments page number link for the current request. + * Filters the comments page number link for the current request. * * @since 2.7.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 ); } /** - * Return the link to next comments page. + * Retrieves the link to the next comments page. * * @since 2.7.1 * - * @param string $label Optional. Label for link text. - * @param int $max_page Optional. Max page. - * @return string|null + * @global WP_Query $wp_query + * + * @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. */ function get_next_comments_link( $label = '', $max_page = 0 ) { global $wp_query; - if ( !is_singular() || !get_option('page_comments') ) + if ( ! is_singular() ) return; $page = get_query_var('cpage'); + if ( ! $page ) { + $page = 1; + } + $nextpage = intval($page) + 1; if ( empty($max_page) ) @@ -2260,7 +2688,7 @@ function get_next_comments_link( $label = '', $max_page = 0 ) { $label = __('Newer Comments »'); /** - * Filter the anchor tag attributes for the next comments page link. + * Filters the anchor tag attributes for the next comments page link. * * @since 2.7.0 * @@ -2270,27 +2698,27 @@ function get_next_comments_link( $label = '', $max_page = 0 ) { } /** - * Display the link to next comments page. + * Displays the link to the next comments page. * * @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. Default empty. + * @param int $max_page Optional. Max page. Default 0. */ function next_comments_link( $label = '', $max_page = 0 ) { echo get_next_comments_link( $label, $max_page ); } /** - * Return the previous comments page link. + * Retrieves the link to the previous comments page. * * @since 2.7.1 * - * @param string $label Optional. Label for comments link text. - * @return string|null + * @param string $label Optional. Label for comments link text. Default empty. + * @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') ) + if ( ! is_singular() ) return; $page = get_query_var('cpage'); @@ -2304,7 +2732,7 @@ function get_previous_comments_link( $label = '' ) { $label = __('« Older Comments'); /** - * Filter the anchor tag attributes for the previous comments page link. + * Filters the anchor tag attributes for the previous comments page link. * * @since 2.7.0 * @@ -2314,29 +2742,31 @@ function get_previous_comments_link( $label = '' ) { } /** - * Display the previous comments page link. + * Displays the link to the previous comments page. * * @since 2.7.0 * - * @param string $label Optional. Label for comments link text. + * @param string $label Optional. Label for comments link text. Default empty. */ function previous_comments_link( $label = '' ) { echo get_previous_comments_link( $label ); } /** - * Create pagination links for the comments on the current post. + * Displays or retrieves pagination links for the comments on the current post. * * @see paginate_links() * @since 2.7.0 * - * @param string|array $args Optional args. See paginate_links(). - * @return string Markup for pagination links. -*/ -function paginate_comments_links($args = array()) { + * @global WP_Rewrite $wp_rewrite + * + * @param string|array $args Optional args. See paginate_links(). Default empty array. + * @return string|void Markup for pagination links. + */ +function paginate_comments_links( $args = array() ) { global $wp_rewrite; - if ( !is_singular() || !get_option('page_comments') ) + if ( ! is_singular() ) return; $page = get_query_var('cpage'); @@ -2352,7 +2782,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 ); @@ -2364,35 +2794,159 @@ function paginate_comments_links($args = array()) { } /** - * Retrieve the Press This bookmarklet link. + * Retrieves navigation to next/previous set of comments, when applicable. + * + * @since 4.4.0 + * + * @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'. + * } + * @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 ) { + $args = wp_parse_args( $args, array( + 'prev_text' => __( 'Older comments' ), + 'next_text' => __( 'Newer comments' ), + 'screen_reader_text' => __( 'Comments navigation' ), + ) ); + + $prev_link = get_previous_comments_link( $args['prev_text'] ); + $next_link = get_next_comments_link( $args['next_text'] ); + + if ( $prev_link ) { + $navigation .= '
' . $prev_link . '
'; + } + + if ( $next_link ) { + $navigation .= '
' . $next_link . '
'; + } + + $navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'] ); + } + + return $navigation; +} + +/** + * Displays navigation to next/previous set of comments, when applicable. + * + * @since 4.4.0 + * + * @param array $args See get_the_comments_navigation() for available arguments. Default empty array. + */ +function the_comments_navigation( $args = array() ) { + echo get_the_comments_navigation( $args ); +} + +/** + * Retrieves a paginated navigation to next/previous set of comments, when applicable. + * + * @since 4.4.0 + * + * @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'. + * } + * @return string Markup for pagination links. + */ +function get_the_comments_pagination( $args = array() ) { + $navigation = ''; + $args = wp_parse_args( $args, array( + 'screen_reader_text' => __( 'Comments navigation' ), + ) ); + $args['echo'] = false; + + // Make sure we get plain links, so we get a string we can work with. + $args['type'] = 'plain'; + + $links = paginate_comments_links( $args ); + + if ( $links ) { + $navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'] ); + } + + return $navigation; +} + +/** + * Displays a paginated navigation to next/previous set of comments, when applicable. * - * Use this in 'a' element 'href' attribute. + * @since 4.4.0 + * + * @param array $args See get_the_comments_pagination() for available arguments. Default empty array. + */ +function the_comments_pagination( $args = array() ) { + echo get_the_comments_pagination( $args ); +} + +/** + * Retrieves the Press This bookmarklet link. * * @since 2.6.0 * - * @return string + * @global bool $is_IE Whether the browser matches an Internet Explorer user agent. + * @global string $wp_version WP version. + * + * @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. + * Filters the Press This bookmarklet link. * * @since 2.6.0 * @@ -2402,39 +2956,43 @@ function get_shortcut_link() { } /** - * Retrieve the home url for the current site. + * Retrieves the URL for the current site where the front end is accessible. * * Returns the 'home' option with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is - * overridden. + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', + * `is_ssl()` is overridden. * * @since 3.0.0 * - * @uses get_home_url() - * - * @param string $path (optional) Path relative to the home url. - * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'. - * @return string Home url link with optional path appended. -*/ + * @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 + * '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 ); } /** - * Retrieve the home url for a given site. + * Retrieves the URL for a given site where the front end is accessible. * * Returns the 'home' option with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is - * overridden. + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', + * `is_ssl()` is overridden. * * @since 3.0.0 * - * @param int $blog_id (optional) Blog ID. Defaults to current blog. - * @param string $path (optional) Path relative to the home url. - * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'. - * @return string Home url link with optional path appended. -*/ + * @global string $pagenow + * + * @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|null $scheme Optional. Scheme to give the home URL context. Accepts + * '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; + $orig_scheme = $scheme; if ( empty( $blog_id ) || !is_multisite() ) { @@ -2446,7 +3004,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { } if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) { - if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] ) + if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $pagenow ) $scheme = 'https'; else $scheme = parse_url( $url, PHP_URL_SCHEME ); @@ -2458,20 +3016,22 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { $url .= '/' . ltrim( $path, '/' ); /** - * Filter the home URL. + * Filters the home URL. * * @since 3.0.0 * * @param string $url The complete home URL including scheme and path. * @param string $path Path relative to the home URL. Blank string if no path is specified. - * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', 'relative' or null. - * @param int|null $blog_id Blog ID, or null for the current blog. + * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', + * 'relative', 'rest', or null. + * @param int|null $blog_id Site ID, or null for the current site. */ return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); } /** - * Retrieve the site url for the current site. + * Retrieves the URL for the current site where WordPress application files + * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. * * Returns the 'site_url' option with the appropriate protocol, 'https' if * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is @@ -2479,30 +3039,31 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { * * @since 3.0.0 * - * @uses get_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. -*/ + * @param string $path Optional. Path relative to the site URL. Default empty. + * @param string $scheme Optional. Scheme to give the site URL context. See set_url_scheme(). + * @return string Site URL link with optional path appended. + */ function site_url( $path = '', $scheme = null ) { return get_site_url( null, $path, $scheme ); } /** - * Retrieve the site url for a given site. + * Retrieves the URL for a given site where WordPress application files + * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. * * Returns the 'site_url' option with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is - * overridden. + * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', + * `is_ssl()` is overridden. * * @since 3.0.0 * - * @param int $blog_id (optional) Blog ID. Defaults to current blog. - * @param string $path Optional. Path relative to the site url. - * @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'. - * @return string Site url link with optional path appended. -*/ + * @param int $blog_id Optional. Site ID. Default null (current site). + * @param string $path Optional. Path relative to the site URL. Default empty. + * @param string $scheme Optional. Scheme to give the site URL context. Accepts + * 'http', 'https', 'login', 'login_post', 'admin', or + * 'relative'. Default null. + * @return string Site URL link with optional path appended. + */ function get_site_url( $blog_id = null, $path = '', $scheme = null ) { if ( empty( $blog_id ) || !is_multisite() ) { $url = get_option( 'siteurl' ); @@ -2518,7 +3079,7 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) { $url .= '/' . ltrim( $path, '/' ); /** - * Filter the site URL. + * Filters the site URL. * * @since 2.7.0 * @@ -2526,34 +3087,37 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) { * @param string $path Path relative to the site URL. Blank string if no path is specified. * @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login', * 'login_post', 'admin', 'relative' or null. - * @param int|null $blog_id Blog ID, or null for the current blog. + * @param int|null $blog_id Site ID, or null for the current site. */ return apply_filters( 'site_url', $url, $path, $scheme, $blog_id ); } /** - * Retrieve the url to the admin area for the current site. + * Retrieves the URL to the admin area for the current site. * * @since 2.6.0 * - * @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. -*/ + * @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. + */ function admin_url( $path = '', $scheme = 'admin' ) { return get_admin_url( null, $path, $scheme ); } /** - * Retrieve the url to the admin area for a given site. + * Retrieves the URL to the admin area for a given site. * * @since 3.0.0 * - * @param int $blog_id (optional) Blog ID. Defaults to current blog. - * @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. -*/ + * @param int $blog_id Optional. Site ID. Default null (current site). + * @param string $path Optional. Path relative to the admin URL. Default empty. + * @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https', + * to force those schemes. Default 'admin', which obeys + * force_ssl_admin() and is_ssl(). + * @return string Admin URL link with optional path appended. + */ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { $url = get_site_url($blog_id, 'wp-admin/', $scheme); @@ -2561,26 +3125,27 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { $url .= ltrim( $path, '/' ); /** - * Filter the admin area URL. + * Filters the admin area URL. * * @since 2.8.0 * * @param string $url The complete admin area URL including scheme and path. * @param string $path Path relative to the admin area URL. Blank string if no path is specified. - * @param int|null $blog_id Blog ID, or null for the current blog. + * @param int|null $blog_id Site ID, or null for the current site. */ return apply_filters( 'admin_url', $url, $path, $blog_id ); } /** - * Retrieve the url to the includes directory. + * Retrieves the URL to the includes directory. * * @since 2.6.0 * - * @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. -*/ + * @param string $path Optional. Path relative to the includes URL. Default empty. + * @param string $scheme Optional. Scheme to give the includes URL context. Accepts + * 'http', 'https', or 'relative'. Default null. + * @return string Includes URL link with optional path appended. + */ function includes_url( $path = '', $scheme = null ) { $url = site_url( '/' . WPINC . '/', $scheme ); @@ -2588,7 +3153,7 @@ function includes_url( $path = '', $scheme = null ) { $url .= ltrim($path, '/'); /** - * Filter the URL to the includes directory. + * Filters the URL to the includes directory. * * @since 2.8.0 * @@ -2600,21 +3165,21 @@ function includes_url( $path = '', $scheme = null ) { } /** - * Retrieve the url to the content directory. + * Retrieves the URL to the content directory. * * @since 2.6.0 * - * @param string $path Optional. Path relative to the content url. - * @return string Content url link with optional path appended. -*/ -function content_url($path = '') { + * @param string $path Optional. Path relative to the content URL. Default empty. + * @return string Content URL link with optional path appended. + */ +function content_url( $path = '' ) { $url = set_url_scheme( WP_CONTENT_URL ); if ( $path && is_string( $path ) ) $url .= '/' . ltrim($path, '/'); /** - * Filter the URL to the content directory. + * Filters the URL to the content directory. * * @since 2.8.0 * @@ -2626,7 +3191,7 @@ function content_url($path = '') { } /** - * Retrieve a URL within the plugins or mu-plugins directory. + * Retrieves a URL within the plugins or mu-plugins directory. * * Defaults to the plugins directory URL if no arguments are supplied. * @@ -2638,7 +3203,7 @@ function content_url($path = '') { * The URL will be relative to its directory. Default empty. * 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 ); @@ -2663,7 +3228,7 @@ function plugins_url( $path = '', $plugin = '' ) { $url .= '/' . ltrim($path, '/'); /** - * Filter the URL to the plugins directory. + * Filters the URL to the plugins directory. * * @since 2.8.0 * @@ -2677,18 +3242,21 @@ function plugins_url( $path = '', $plugin = '' ) { } /** - * Retrieve the site url for the current network. + * Retrieves the site URL for the current network. * - * Returns the site url with the appropriate protocol, 'https' if + * Returns the site URL with the appropriate protocol, 'https' if * is_ssl() 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 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. -*/ + * @see set_url_scheme() + * + * @param string $path Optional. Path relative to the site URL. Default empty. + * @param string $scheme Optional. Scheme to give the site URL context. Accepts + * 'http', 'https', or 'relative'. Default null. + * @return string Site URL link with optional path appended. + */ function network_site_url( $path = '', $scheme = null ) { if ( ! is_multisite() ) return site_url($path, $scheme); @@ -2704,7 +3272,7 @@ function network_site_url( $path = '', $scheme = null ) { $url .= ltrim( $path, '/' ); /** - * Filter the network site URL. + * Filters the network site URL. * * @since 3.0.0 * @@ -2718,18 +3286,19 @@ function network_site_url( $path = '', $scheme = null ) { } /** - * Retrieve the home url for the current network. + * Retrieves the home URL for the current network. * - * Returns the home url with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is + * Returns the home URL with the appropriate protocol, 'https' is_ssl() + * 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. - * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'. - * @return string Home url link with optional path appended. -*/ + * @param string $path Optional. Path relative to the home URL. Default empty. + * @param string $scheme Optional. Scheme to give the home URL context. Accepts + * '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); @@ -2749,7 +3318,7 @@ function network_home_url( $path = '', $scheme = null ) { $url .= ltrim( $path, '/' ); /** - * Filter the network home URL. + * Filters the network home URL. * * @since 3.0.0 * @@ -2763,14 +3332,15 @@ function network_home_url( $path = '', $scheme = null ) { } /** - * Retrieve the url to the admin area for the network. + * Retrieves the URL to the admin area for the network. * * @since 3.0.0 * - * @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. -*/ + * @param string $path Optional path relative to the admin URL. Default empty. + * @param string $scheme Optional. 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. + */ function network_admin_url( $path = '', $scheme = 'admin' ) { if ( ! is_multisite() ) return admin_url( $path, $scheme ); @@ -2781,7 +3351,7 @@ function network_admin_url( $path = '', $scheme = 'admin' ) { $url .= ltrim($path, '/'); /** - * Filter the network admin URL. + * Filters the network admin URL. * * @since 3.0.0 * @@ -2793,14 +3363,15 @@ function network_admin_url( $path = '', $scheme = 'admin' ) { } /** - * Retrieve the url to the admin area for the current user. + * Retrieves the URL to the admin area for the current user. * * @since 3.0.0 * - * @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. -*/ + * @param string $path Optional. Path relative to the admin URL. Default empty. + * @param string $scheme Optional. 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. + */ function user_admin_url( $path = '', $scheme = 'admin' ) { $url = network_site_url('wp-admin/user/', $scheme); @@ -2808,7 +3379,7 @@ function user_admin_url( $path = '', $scheme = 'admin' ) { $url .= ltrim($path, '/'); /** - * Filter the user admin URL for the current user. + * Filters the user admin URL for the current user. * * @since 3.1.0 * @@ -2820,15 +3391,16 @@ function user_admin_url( $path = '', $scheme = 'admin' ) { } /** - * Retrieve the url to the admin area for either the current blog or the network depending on context. + * Retrieves the URL to the admin area for either the current site or the network depending on context. * * @since 3.1.0 * - * @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. -*/ -function self_admin_url($path = '', $scheme = 'admin') { + * @param string $path Optional. Path relative to the admin URL. Default empty. + * @param string $scheme Optional. 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. + */ +function self_admin_url( $path = '', $scheme = 'admin' ) { if ( is_network_admin() ) return network_admin_url($path, $scheme); elseif ( is_user_admin() ) @@ -2838,12 +3410,14 @@ function self_admin_url($path = '', $scheme = 'admin') { } /** - * Set the scheme for a URL + * Sets the scheme for a URL. * * @since 3.4.0 + * @since 4.4.0 The 'rest' scheme was added. * - * @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'. + * @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. */ function set_url_scheme( $url, $scheme = null ) { @@ -2870,31 +3444,33 @@ function set_url_scheme( $url, $scheme = null ) { } /** - * Filter the resulting URL after setting the scheme. + * Filters the resulting URL after setting the scheme. * * @since 3.4.0 * - * @param string $url The complete URL including scheme and path. - * @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'. - * @param string $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login', - * 'login_post', 'admin', 'rpc', or 'relative'. + * @param string $url The complete URL including scheme and path. + * @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'. + * @param string|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login', + * 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. */ return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme ); } /** - * Get the URL to the user's dashboard. + * Retrieves the URL to the user's dashboard. * - * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site, - * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's - * primary blog is returned. + * If a user does not belong to any site, the global user dashboard is used. If the user + * belongs to the current site, the dashboard for the current site is returned. If the user + * cannot edit the current site, the dashboard to the user's primary site is returned. * * @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. - * @return string Dashboard url link with optional path appended. + * @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 site and user admins. Default empty. + * @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' ) { $user_id = $user_id ? (int) $user_id : get_current_user_id(); @@ -2918,7 +3494,7 @@ function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) { } /** - * Filter the dashboard URL for a user. + * Filters the dashboard URL for a user. * * @since 3.1.0 * @@ -2932,14 +3508,14 @@ function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) { } /** - * Get the URL to the user's profile editor. + * Retrieves the URL to the user's profile editor. * * @since 3.1.0 * * @param int $user_id Optional. User ID. Defaults to current user. - * @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. + * @param string $scheme Optional. 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_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { $user_id = $user_id ? (int) $user_id : get_current_user_id(); @@ -2952,7 +3528,7 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { $url = get_dashboard_url( $user_id, 'profile.php', $scheme ); /** - * Filter the URL for a user's profile editor. + * Filters the URL for a user's profile editor. * * @since 3.1.0 * @@ -2965,44 +3541,105 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { } /** - * Output rel=canonical for singular queries. + * Returns the canonical URL for a post. + * + * When the post is the same as the current requested page the function will handle the + * pagination arguments too. + * + * @since 4.6.0 + * + * @param int|WP_Post $post Optional. Post ID or object. Default is global `$post`. + * @return string|false The canonical URL, or false if the post does not exist or has not + * been published yet. + */ +function wp_get_canonical_url( $post = null ) { + $post = get_post( $post ); + + if ( ! $post ) { + return false; + } + + if ( 'publish' !== $post->post_status ) { + return false; + } + + $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() ) { + $page = get_query_var( 'page', 0 ); + if ( $page >= 2 ) { + 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' ); + } + } + + $cpage = get_query_var( 'cpage', 0 ); + if ( $cpage ) { + $canonical_url = get_comments_pagenum_link( $cpage ); + } + } + + /** + * Filters the canonical URL for a post. + * + * @since 4.6.0 + * + * @param string $string The post's canonical URL. + * @param WP_Post $post Post object. + */ + return apply_filters( 'get_canonical_url', $canonical_url, $post ); +} + +/** + * Outputs rel=canonical for singular queries. * * @since 2.9.0 -*/ + * @since 4.6.0 Adjusted to use wp_get_canonical_url(). + */ function rel_canonical() { - if ( !is_singular() ) + if ( ! is_singular() ) { return; + } - global $wp_the_query; - if ( !$id = $wp_the_query->get_queried_object_id() ) - return; + $id = get_queried_object_id(); - $link = get_permalink( $id ); + if ( 0 === $id ) { + return; + } - if ( $page = get_query_var('cpage') ) - $link = get_comments_pagenum_link( $page ); + $url = wp_get_canonical_url( $id ); - echo "\n"; + if ( ! empty( $url ) ) { + echo '' . "\n"; + } } /** - * Return a shortlink for a post, page, attachment, or blog. + * Returns a shortlink for a post, page, attachment, or site. * - * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to - * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts. - * Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output - * via the get_shortlink filter. + * This function exists to provide a shortlink tag that all themes and plugins can target. + * A plugin must hook in to provide the actual shortlinks. Default shortlink support is + * limited to providing ?p= style links for posts. Plugins can short-circuit this function + * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} + * filter. * * @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. - * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled. + * @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', + * the post_type of the post is consulted. If 'query', the current query is consulted + * 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) { +function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) { /** - * Filter whether to preempt generating a shortlink for the given post. + * Filters whether to preempt generating a shortlink for the given post. * * Passing a truthy value to the filter will effectively short-circuit the * shortlink-generation process, returning that value instead. @@ -3016,13 +3653,13 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) { */ $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs ); - if ( false !== $shortlink ) + if ( false !== $shortlink ) { return $shortlink; + } - global $wp_query; $post_id = 0; if ( 'query' == $context && is_singular() ) { - $post_id = $wp_query->get_queried_object_id(); + $post_id = get_queried_object_id(); $post = get_post( $post_id ); } elseif ( 'post' == $context ) { $post = get_post( $id ); @@ -3044,7 +3681,7 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) { } /** - * Filter the shortlink for a post. + * Filters the shortlink for a post. * * @since 3.0.0 * @@ -3057,13 +3694,11 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) { } /** - * Inject rel=shortlink into head if a shortlink is defined for the current page. + * Injects rel=shortlink into the head if a shortlink is defined for the current page. * - * Attached to the wp_head action. + * Attached to the {@see 'wp_head'} action. * * @since 3.0.0 - * - * @uses wp_get_shortlink() */ function wp_shortlink_wp_head() { $shortlink = wp_get_shortlink( 0, 'query' ); @@ -3075,13 +3710,11 @@ function wp_shortlink_wp_head() { } /** - * Send a Link: rel=shortlink header if a shortlink is defined for the current page. + * Sends a Link: rel=shortlink header if a shortlink is defined for the current page. * - * Attached to the wp action. + * Attached to the {@see 'wp'} action. * * @since 3.0.0 - * - * @uses wp_get_shortlink() */ function wp_shortlink_header() { if ( headers_sent() ) @@ -3096,18 +3729,18 @@ function wp_shortlink_header() { } /** - * Display the Short Link for a Post + * Displays the shortlink for a post. * * Must be called from inside "The Loop" * - * Call like the_shortlink(__('Shortlinkage FTW')) + * Call like the_shortlink( __( 'Shortlinkage FTW' ) ) * * @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 $before Optional HTML to display before the link. - * @param string $after Optional HTML to display after the link. + * @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. Default empty. + * @param string $after Optional HTML to display after the link. Default empty. */ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { $post = get_post(); @@ -3124,7 +3757,7 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { $link = '' . $text . ''; /** - * Filter the shortlink anchor tag for a post. + * Filters the short link anchor tag for a post. * * @since 3.0.0 * @@ -3137,3 +3770,259 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { echo $before, $link, $after; } } + + +/** + * Retrieves 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 WP_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 'mysteryman' (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']; +} + +/** + * 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, + * 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. + * @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 'mysteryman' (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; + + /** + * Filters 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 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. + */ + $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; + + 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 + 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 ( $id_or_email instanceof WP_Comment ) { + /** + * Filters 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'] ) + ); + + /** + * 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, + * 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 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. + */ + return apply_filters( 'get_avatar_data', $args, $id_or_email ); +}