X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/61343b82c4f0da4c68e4c6373daafff4a81efdd1..9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f:/wp-includes/link-template.php diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php index f52f8ea2..7a7b7874 100644 --- a/wp-includes/link-template.php +++ b/wp-includes/link-template.php @@ -10,9 +10,15 @@ * Display the permalink for the current post. * * @since 1.2.0 - * @uses apply_filters() Calls 'the_permalink' filter on the permalink string. */ function the_permalink() { + /** + * Filter the display of the permalink for the current post. + * + * @since 1.5.0 + * + * @param string $permalink The permalink for the current post. + */ echo esc_url( apply_filters( 'the_permalink', get_permalink() ) ); } @@ -38,9 +44,18 @@ function user_trailingslashit($string, $type_of_url = '') { else $string = untrailingslashit($string); - // Note that $type_of_url can be one of following: - // single, single_trackback, single_feed, single_paged, feed, category, page, year, month, day, paged, post_type_archive - $string = apply_filters('user_trailingslashit', $string, $type_of_url); + /** + * Filter the trailing slashed string, depending on whether the site is set + * to use training slashes. + * + * @since 2.2.0 + * + * @param string $string URL with or without a trailing slash. + * @param string $type_of_url The type of URL being considered. Accepts 'single', 'single_trackback', + * '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; } @@ -68,14 +83,31 @@ function permalink_anchor( $mode = 'id' ) { } } +/** + * Retrieve full permalink for current post or post ID. + * + * This function is an alias for get_permalink(). + * + * @since 3.9.0 + * + * @see get_permalink() + * + * @param int|WP_Post $id Optional. Post ID or post object. Default is the current post. + * @param bool $leavename Optional. Whether to keep post name or page name. Default false. + * @return string|bool The permalink URL or false if post does not exist. + */ +function get_the_permalink( $id = 0, $leavename = false ) { + return get_permalink( $id, $leavename ); +} + /** * Retrieve full permalink for current post or post ID. * * @since 1.0.0 * - * @param int $id Optional. Post ID. - * @param bool $leavename Optional, defaults to false. Whether to keep post name or page name. - * @return string + * @param int|WP_Post $id Optional. Post ID or post object. Default current post. + * @param bool $leavename Optional. Whether to keep post name or page name. Default false. + * @return string|bool The permalink URL or false if post does not exist. */ function get_permalink( $id = 0, $leavename = false ) { $rewritecode = array( @@ -104,15 +136,26 @@ function get_permalink( $id = 0, $leavename = false ) { return false; if ( $post->post_type == 'page' ) - return get_page_link($post->ID, $leavename, $sample); + return get_page_link($post, $leavename, $sample); elseif ( $post->post_type == 'attachment' ) - return get_attachment_link( $post->ID, $leavename ); + return get_attachment_link( $post, $leavename ); elseif ( in_array($post->post_type, get_post_types( array('_builtin' => false) ) ) ) - return get_post_permalink($post->ID, $leavename, $sample); + return get_post_permalink($post, $leavename, $sample); $permalink = get_option('permalink_structure'); - $permalink = apply_filters('pre_post_link', $permalink, $post, $leavename); + /** + * Filter the permalink structure for a post before token replacement occurs. + * + * Only applies to posts with post_type of 'post'. + * + * @since 3.0.0 + * + * @param string $permalink The site's permalink structure. + * @param WP_Post $post The post in question. + * @param bool $leavename Whether to keep the post name. + */ + $permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename ); if ( '' != $permalink && !in_array($post->post_status, array('draft', 'pending', 'auto-draft')) ) { $unixtime = strtotime($post->post_date); @@ -122,7 +165,18 @@ function get_permalink( $id = 0, $leavename = false ) { $cats = get_the_category($post->ID); if ( $cats ) { usort($cats, '_usort_terms_by_ID'); // order by ID + + /** + * Filter the category that gets used in the %category% permalink token. + * + * @since 3.5.0 + * + * @param stdClass $cat The category to use in the permalink. + * @param array $cats Array of all categories associated with the post. + * @param WP_Post $post The post in question. + */ $category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post ); + $category_object = get_term( $category_object, 'category' ); $category = $category_object->slug; if ( $parent = $category_object->parent ) @@ -131,7 +185,7 @@ function get_permalink( $id = 0, $leavename = false ) { // show default category in permalinks, without // having to assign it explicitly if ( empty($category) ) { - $default_category = get_category( get_option( 'default_category' ) ); + $default_category = get_term( get_option( 'default_category' ), 'category' ); $category = is_wp_error( $default_category ) ? '' : $default_category->slug; } } @@ -162,7 +216,19 @@ function get_permalink( $id = 0, $leavename = false ) { } else { // if they're not using the fancy permalink option $permalink = home_url('?p=' . $post->ID); } - return apply_filters('post_link', $permalink, $post, $leavename); + + /** + * Filter the permalink for a post. + * + * Only applies to posts with post_type of 'post'. + * + * @since 1.5.0 + * + * @param string $permalink The post's permalink. + * @param WP_Post $post The post in question. + * @param bool $leavename Whether to keep the post name. + */ + return apply_filters( 'post_link', $permalink, $post, $leavename ); } /** @@ -206,7 +272,17 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) { $post_link = home_url($post_link); } - return apply_filters('post_type_link', $post_link, $post, $leavename, $sample); + /** + * Filter the permalink for a post with a custom post type. + * + * @since 3.0.0 + * + * @param string $post_link The post's permalink. + * @param WP_Post $post The post in question. + * @param bool $leavename Whether to keep the post name. + * @param bool $sample Is it a sample permalink. + */ + return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample ); } /** @@ -214,7 +290,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) { * * @since 1.0.0 * - * @param int $post_id Optional. Post ID. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @param mixed $deprecated Not used. * @return string */ @@ -245,6 +321,15 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) { else $link = _get_page_link( $post, $leavename, $sample ); + /** + * Filter the permalink for a page. + * + * @since 1.5.0 + * + * @param string $link The page's permalink. + * @param int $post_id The ID of the page. + * @param bool $sample Is it a sample permalink. + */ return apply_filters( 'page_link', $link, $post->ID, $sample ); } @@ -281,6 +366,14 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) { $link = home_url( '?page_id=' . $post->ID ); } + /** + * Filter the permalink for a non-page_on_front page. + * + * @since 2.1.0 + * + * @param string $link The page's permalink. + * @param int $post_id The ID of the page. + */ return apply_filters( '_get_page_link', $link, $post->ID ); } @@ -324,6 +417,14 @@ function get_attachment_link( $post = null, $leavename = false ) { if ( ! $link ) $link = home_url( '/?attachment_id=' . $post->ID ); + /** + * Filter the permalink for an attachment. + * + * @since 2.0.0 + * + * @param string $link The attachment's permalink. + * @param int $post_id Attachment ID. + */ return apply_filters( 'attachment_link', $link, $post->ID ); } @@ -342,10 +443,20 @@ function get_year_link($year) { $yearlink = $wp_rewrite->get_year_permastruct(); if ( !empty($yearlink) ) { $yearlink = str_replace('%year%', $year, $yearlink); - return apply_filters('year_link', home_url( user_trailingslashit($yearlink, 'year') ), $year); + $yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) ); } else { - return apply_filters('year_link', home_url('?m=' . $year), $year); + $yearlink = home_url( '?m=' . $year ); } + + /** + * Filter the year archive permalink. + * + * @since 1.5.0 + * + * @param string $yearlink Permalink for the year archive. + * @param int $year Year for the archive. + */ + return apply_filters( 'year_link', $yearlink, $year ); } /** @@ -367,10 +478,21 @@ function get_month_link($year, $month) { if ( !empty($monthlink) ) { $monthlink = str_replace('%year%', $year, $monthlink); $monthlink = str_replace('%monthnum%', zeroise(intval($month), 2), $monthlink); - return apply_filters('month_link', home_url( user_trailingslashit($monthlink, 'month') ), $year, $month); + $monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) ); } else { - return apply_filters('month_link', home_url( '?m=' . $year . zeroise($month, 2) ), $year, $month); + $monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) ); } + + /** + * Filter the month archive permalink. + * + * @since 1.5.0 + * + * @param string $monthlink Permalink for the month archive. + * @param int $year Year for the archive. + * @param int $month The month for the archive. + */ + return apply_filters( 'month_link', $monthlink, $year, $month ); } /** @@ -397,10 +519,22 @@ function get_day_link($year, $month, $day) { $daylink = str_replace('%year%', $year, $daylink); $daylink = str_replace('%monthnum%', zeroise(intval($month), 2), $daylink); $daylink = str_replace('%day%', zeroise(intval($day), 2), $daylink); - return apply_filters('day_link', home_url( user_trailingslashit($daylink, 'day') ), $year, $month, $day); + $daylink = home_url( user_trailingslashit( $daylink, 'day' ) ); } else { - return apply_filters('day_link', home_url( '?m=' . $year . zeroise($month, 2) . zeroise($day, 2) ), $year, $month, $day); + $daylink = home_url( '?m=' . $year . zeroise( $month, 2 ) . zeroise( $day, 2 ) ); } + + /** + * Filter the day archive permalink. + * + * @since 1.5.0 + * + * @param string $daylink Permalink for the day archive. + * @param int $year Year for the archive. + * @param int $month Month for the archive. + * @param int $day The day for the archive. + */ + return apply_filters( 'day_link', $daylink, $year, $month, $day ); } /** @@ -413,6 +547,16 @@ function get_day_link($year, $month, $day) { */ function the_feed_link( $anchor, $feed = '' ) { $link = '' . $anchor . ''; + + /** + * Filter the feed link anchor tag. + * + * @since 3.0.0 + * + * @param string $link The complete anchor tag for a feed link. + * @param string $feed The feed type, or an empty string for the + * default feed type. + */ echo apply_filters( 'the_feed_link', $link, $feed ); } @@ -450,7 +594,15 @@ function get_feed_link($feed = '') { $output = home_url("?feed={$feed}"); } - return apply_filters('feed_link', $output, $feed); + /** + * Filter the feed type permalink. + * + * @since 1.5.0 + * + * @param string $output The feed permalink. + * @param string $feed Feed type. + */ + return apply_filters( 'feed_link', $output, $feed ); } /** @@ -489,7 +641,14 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') { $url = add_query_arg( array( 'feed' => $feed, 'p' => $post_id ), home_url( '/' ) ); } - return apply_filters('post_comments_feed_link', $url); + /** + * Filter the post comments feed permalink. + * + * @since 1.5.1 + * + * @param string $url Post comments feed permalink. + */ + return apply_filters( 'post_comments_feed_link', $url ); } /** @@ -499,8 +658,6 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') { * anchor. If no link text is specified, default text is used. If no post ID is * specified, the current post is used. * - * @package WordPress - * @subpackage Feed * @since 2.5.0 * * @param string $link_text Descriptive text. @@ -513,6 +670,15 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { if ( empty($link_text) ) $link_text = __('Comments Feed'); + /** + * Filter the post comment feed link anchor tag. + * + * @since 2.8.0 + * + * @param string $link The complete anchor tag for the comment feed link. + * @param int $post_id Post ID. + * @param string $feed The feed type, or an empty string for the default feed type. + */ echo apply_filters( 'post_comments_feed_link_html', "$link_text", $post_id, $feed ); } @@ -522,8 +688,6 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { * 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. * - * @package WordPress - * @subpackage Feed * @since 2.5.0 * * @param int $author_id ID of an author. @@ -549,7 +713,15 @@ function get_author_feed_link( $author_id, $feed = '' ) { $link = trailingslashit($link) . user_trailingslashit($feed_link, 'feed'); } - $link = apply_filters('author_feed_link', $link, $feed); + /** + * Filter the feed link for a given author. + * + * @since 1.5.1 + * + * @param string $link The author feed link. + * @param string $feed Feed type. + */ + $link = apply_filters( 'author_feed_link', $link, $feed ); return $link; } @@ -560,8 +732,6 @@ function get_author_feed_link( $author_id, $feed = '' ) { * 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. * - * @package WordPress - * @subpackage Feed * @since 2.5.0 * * @param int $cat_id ID of a category. @@ -578,7 +748,7 @@ function get_category_feed_link($cat_id, $feed = '') { * 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 + * @since 3.0.0 * * @param int $term_id ID of a category. * @param string $taxonomy Optional. Taxonomy of $term_id @@ -618,12 +788,38 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' ); } - if ( 'category' == $taxonomy ) + if ( 'category' == $taxonomy ) { + /** + * Filter the category feed link. + * + * @since 1.5.1 + * + * @param string $link The category feed link. + * @param string $feed Feed type. + */ $link = apply_filters( 'category_feed_link', $link, $feed ); - elseif ( 'post_tag' == $taxonomy ) + } elseif ( 'post_tag' == $taxonomy ) { + /** + * Filter the post tag feed link. + * + * @since 2.3.0 + * + * @param string $link The tag feed link. + * @param string $feed Feed type. + */ $link = apply_filters( 'tag_feed_link', $link, $feed ); - else + } else { + /** + * Filter the feed link for a taxonomy other than 'category' or 'post_tag'. + * + * @since 3.0.0 + * + * @param string $link The taxonomy feed link. + * @param string $feed Feed type. + * @param string $feed The taxonomy name. + */ $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy ); + } return $link; } @@ -651,6 +847,13 @@ function get_tag_feed_link($tag_id, $feed = '') { * @return string */ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) { + /** + * Filter the edit link for a tag (or term in another taxonomy). + * + * @since 2.7.0 + * + * @param string $link The term edit link. + */ return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) ); } @@ -662,11 +865,19 @@ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) { * @param string $link Optional. Anchor text. * @param string $before Optional. Display before edit link. * @param string $after Optional. Display after edit link. - * @param int|object $tag Tag object or ID + * @param object $tag Tag object. * @return string HTML content. */ function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) { - $link = edit_term_link( $link, '', '', false, $tag ); + $link = edit_term_link( $link, '', '', $tag, false ); + + /** + * Filter the anchor tag for the edit link for a tag (or term in another taxonomy). + * + * @since 2.7.0 + * + * @param string $link The anchor tag for the edit link. + */ echo $before . apply_filters( 'edit_tag_link', $link ) . $after; } @@ -698,6 +909,16 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) { $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) ); + /** + * Filter the edit link for a term. + * + * @since 3.1.0 + * + * @param string $location The edit link. + * @param int $term_id Term ID. + * @param string $taxonomy Taxonomy name. + * @param string $object_type The object type (eg. the post type). + */ return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type ); } @@ -709,22 +930,33 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) { * @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 + * @param object $term Term object. * @return string HTML content. */ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) { - if ( is_null( $term ) ) { + if ( is_null( $term ) ) $term = get_queried_object(); - } + + if ( ! $term ) + return; $tax = get_taxonomy( $term->taxonomy ); - if ( !current_user_can($tax->cap->edit_terms) ) + if ( ! current_user_can( $tax->cap->edit_terms ) ) return; if ( empty( $link ) ) $link = __('Edit This'); - $link = '' . $link . ''; + $link = '' . $link . ''; + + /** + * Filter the anchor tag for the edit link of a term. + * + * @since 3.1.0 + * + * @param string $link The anchor tag for the edit link. + * @param int $term_id Term ID. + */ $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after; if ( $echo ) @@ -734,12 +966,13 @@ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $e } /** -* Retrieve permalink for search. -* -* @since 3.0.0 -* @param string $query Optional. The query string to use. If empty the current query is used. -* @return string -*/ + * Retrieve permalink for search. + * + * @since 3.0.0 + * + * @param string $query Optional. The query string to use. If empty the current query is used. + * @return string + */ function get_search_link( $query = '' ) { global $wp_rewrite; @@ -759,6 +992,14 @@ function get_search_link( $query = '' ) { $link = home_url( user_trailingslashit( $link, 'search' ) ); } + /** + * Filter the search permalink. + * + * @since 3.0.0 + * + * @param string $link Search permalink. + * @param string $search The URL-encoded search term. + */ return apply_filters( 'search_link', $link, $search ); } @@ -787,7 +1028,16 @@ function get_search_feed_link($search_query = '', $feed = '') { $link .= "feed/$feed/"; } - $link = apply_filters('search_feed_link', $link, $feed, 'posts'); + /** + * Filter the search feed link. + * + * @since 2.5.0 + * + * @param string $link Search feed link. + * @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; } @@ -816,6 +1066,7 @@ function get_search_comments_feed_link($search_query = '', $feed = '') { else $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; @@ -848,6 +1099,14 @@ function get_post_type_archive_link( $post_type ) { $link = home_url( '?post_type=' . $post_type ); } + /** + * Filter the post type archive permalink. + * + * @since 3.1.0 + * + * @param string $link The post type archive permalink. + * @param string $post_type Post type name. + */ return apply_filters( 'post_type_archive_link', $link, $post_type ); } @@ -878,6 +1137,14 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { $link = add_query_arg( 'feed', $feed, $link ); } + /** + * Filter the post type archive feed link. + * + * @since 3.1.0 + * + * @param string $link The post type archive feed link. + * @param string $feed Feed type. + */ return apply_filters( 'post_type_archive_feed_link', $link, $feed ); } @@ -911,7 +1178,17 @@ function get_edit_post_link( $id = 0, $context = 'display' ) { if ( !current_user_can( 'edit_post', $post->ID ) ) return; - return apply_filters( 'get_edit_post_link', admin_url( sprintf($post_type_object->_edit_link . $action, $post->ID) ), $post->ID, $context ); + /** + * Filter the post edit link. + * + * @since 2.3.0 + * + * @param string $link The edit link. + * @param int $post_id Post ID. + * @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 ); } /** @@ -919,24 +1196,36 @@ function get_edit_post_link( $id = 0, $context = 'display' ) { * * @since 1.0.0 * - * @param string $link Optional. Anchor text. + * @param string $text Optional. Anchor text. * @param string $before Optional. Display before edit link. * @param string $after Optional. Display after edit link. * @param int $id Optional. Post ID. */ -function edit_post_link( $link = null, $before = '', $after = '', $id = 0 ) { - if ( !$post = get_post( $id ) ) +function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) { + if ( ! $post = get_post( $id ) ) { return; + } - if ( !$url = get_edit_post_link( $post->ID ) ) + if ( ! $url = get_edit_post_link( $post->ID ) ) { return; + } - if ( null === $link ) - $link = __('Edit This'); + if ( null === $text ) { + $text = __( 'Edit This' ); + } + + $link = '' . $text . ''; - $post_type_obj = get_post_type_object( $post->post_type ); - $link = '' . $link . ''; - echo $before . apply_filters( 'edit_post_link', $link, $post->ID ) . $after; + /** + * Filter the post edit link anchor tag. + * + * @since 2.3.0 + * + * @param string $link Anchor tag for the edit link. + * @param int $post_id Post ID. + * @param string $text Anchor text. + */ + echo $before . apply_filters( 'edit_post_link', $link, $post->ID, $text ) . $after; } /** @@ -969,6 +1258,15 @@ 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. + * + * @since 2.9.0 + * + * @param string $link The delete link. + * @param int $post_id Post ID. + * @param bool $force_delete Whether to bypass the trash and force deletion. Default false. + */ return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete ); } @@ -987,30 +1285,49 @@ function get_edit_comment_link( $comment_id = 0 ) { return; $location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID; + + /** + * Filter the comment edit link. + * + * @since 2.3.0 + * + * @param string $location The edit link. + */ return apply_filters( 'get_edit_comment_link', $location ); } /** - * Display or retrieve edit comment link with formatting. + * Display edit comment link with formatting. * * @since 1.0.0 * - * @param string $link Optional. Anchor text. + * @param string $text Optional. Anchor text. * @param string $before Optional. Display before edit link. * @param string $after Optional. Display after edit link. - * @return string|null HTML content, if $echo is set to false. */ -function edit_comment_link( $link = null, $before = '', $after = '' ) { +function edit_comment_link( $text = null, $before = '', $after = '' ) { global $comment; - if ( !current_user_can( 'edit_comment', $comment->comment_ID ) ) + if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { return; + } - if ( null === $link ) - $link = __('Edit This'); + if ( null === $text ) { + $text = __( 'Edit This' ); + } - $link = '' . $link . ''; - echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after; + $link = '' . $text . ''; + + /** + * Filter the comment edit link anchor tag. + * + * @since 2.3.0 + * + * @param string $link Anchor tag for the edit link. + * @param int $comment_id Comment ID. + * @param string $text Anchor text. + */ + echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after; } /** @@ -1028,6 +1345,15 @@ function get_edit_bookmark_link( $link = 0 ) { return; $location = admin_url('link.php?action=edit&link_id=') . $link->link_id; + + /** + * Filter the bookmark (link) edit link. + * + * @since 2.7.0 + * + * @param string $location The edit link. + * @param int $link_id Bookmark ID. + */ return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id ); } @@ -1050,7 +1376,16 @@ 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. + * + * @since 2.7.0 + * + * @param string $link Anchor tag for the edit link. + * @param int $link_id Bookmark ID. + */ echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after; } @@ -1079,6 +1414,14 @@ function get_edit_user_link( $user_id = null ) { else $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) ); + /** + * Filter the user edit link. + * + * @since 3.5.0 + * + * @param string $link The edit link. + * @param int $user_id User ID. + */ return apply_filters( 'get_edit_user_link', $link, $user->ID ); } @@ -1089,12 +1432,13 @@ function get_edit_user_link( $user_id = null ) { * * @since 1.5.0 * - * @param bool $in_same_cat Optional. Whether post should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. + * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. */ -function get_previous_post($in_same_cat = false, $excluded_categories = '') { - return get_adjacent_post($in_same_cat, $excluded_categories); +function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy ); } /** @@ -1102,12 +1446,13 @@ function get_previous_post($in_same_cat = false, $excluded_categories = '') { * * @since 1.5.0 * - * @param bool $in_same_cat Optional. Whether post should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. + * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. */ -function get_next_post($in_same_cat = false, $excluded_categories = '') { - return get_adjacent_post($in_same_cat, $excluded_categories, false); +function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy ); } /** @@ -1117,55 +1462,56 @@ function get_next_post($in_same_cat = false, $excluded_categories = '') { * * @since 2.5.0 * - * @param bool $in_same_cat Optional. Whether post should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @param bool $previous Optional. Whether to retrieve previous post. - * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. + * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. + * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. + * @param bool $previous Optional. Whether to retrieve previous post. + * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists. */ -function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $previous = true ) { +function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { global $wpdb; - if ( ! $post = get_post() ) + if ( ( ! $post = get_post() ) || ! taxonomy_exists( $taxonomy ) ) return null; $current_post_date = $post->post_date; $join = ''; - $posts_in_ex_cats_sql = ''; - if ( $in_same_cat || ! empty( $excluded_categories ) ) { + $where = ''; + + 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'" ) ); + $excluded_terms = explode( ' and ', $excluded_terms ); + } else { + $excluded_terms = explode( ',', $excluded_terms ); + } - if ( $in_same_cat ) { - if ( ! is_object_in_taxonomy( $post->post_type, 'category' ) ) - return ''; - $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids')); - if ( ! $cat_array || is_wp_error( $cat_array ) ) - return ''; - $join .= " AND tt.taxonomy = 'category' AND tt.term_id IN (" . implode(',', $cat_array) . ")"; + $excluded_terms = array_map( 'intval', $excluded_terms ); } - $posts_in_ex_cats_sql = "AND tt.taxonomy = 'category'"; - if ( ! empty( $excluded_categories ) ) { - if ( ! is_array( $excluded_categories ) ) { - // back-compat, $excluded_categories used to be IDs separated by " and " - if ( strpos( $excluded_categories, ' and ' ) !== false ) { - _deprecated_argument( __FUNCTION__, '3.3', sprintf( __( 'Use commas instead of %s to separate excluded categories.' ), "'and'" ) ); - $excluded_categories = explode( ' and ', $excluded_categories ); - } else { - $excluded_categories = explode( ',', $excluded_categories ); - } - } + if ( $in_same_term ) { + if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) ) + return ''; + $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); - $excluded_categories = array_map( 'intval', $excluded_categories ); + // Remove any exclusions from the term array to include. + $term_array = array_diff( $term_array, (array) $excluded_terms ); + $term_array = array_map( 'intval', $term_array ); - if ( ! empty( $cat_array ) ) { - $excluded_categories = array_diff($excluded_categories, $cat_array); - $posts_in_ex_cats_sql = ''; - } + if ( ! $term_array || is_wp_error( $term_array ) ) + return ''; - if ( !empty($excluded_categories) ) { - $posts_in_ex_cats_sql = " AND tt.taxonomy = 'category' AND tt.term_id NOT IN (" . implode($excluded_categories, ',') . ')'; - } + $where .= " AND tt.term_id IN (" . implode( ',', $term_array ) . ")"; + } + + 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, ',' ) . ') )'; } } @@ -1173,13 +1519,49 @@ function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $pr $op = $previous ? '<' : '>'; $order = $previous ? 'DESC' : 'ASC'; - $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_cat, $excluded_categories ); - $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' $posts_in_ex_cats_sql", $current_post_date, $post->post_type), $in_same_cat, $excluded_categories ); + /** + * Filter the JOIN clause in the SQL for an adjacent post query. + * + * The dynamic portion of the hook name, $adjacent, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 2.5.0 + * + * @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. + */ + $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms ); + + /** + * Filter the WHERE clause in the SQL for an adjacent post query. + * + * The dynamic portion of the hook name, $adjacent, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 2.5.0 + * + * @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. + */ + $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 ); + + /** + * Filter the ORDER BY clause in the SQL for an adjacent post query. + * + * The dynamic portion of the hook name, $adjacent, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 2.5.0 + * + * @param string $order_by The ORDER BY clause in the SQL. + */ $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" ); $query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort"; - $query_key = 'adjacent_post_' . md5($query); - $result = wp_cache_get($query_key, 'counts'); + $query_key = 'adjacent_post_' . md5( $query ); + $result = wp_cache_get( $query_key, 'counts' ); if ( false !== $result ) { if ( $result ) $result = get_post( $result ); @@ -1190,7 +1572,7 @@ function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $pr if ( null === $result ) $result = ''; - wp_cache_set($query_key, $result, 'counts'); + wp_cache_set( $query_key, $result, 'counts' ); if ( $result ) $result = get_post( $result ); @@ -1205,36 +1587,48 @@ function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $pr * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @param bool $previous Optional, default is true. Whether to display link to previous or next post. + * @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 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 get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $previous = true) { +function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { if ( $previous && is_attachment() && $post = get_post() ) $post = get_post( $post->post_parent ); else - $post = get_adjacent_post( $in_same_cat, $excluded_categories, $previous ); + $post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); - if ( empty($post) ) + if ( empty( $post ) ) return; $post_title = the_title_attribute( array( 'echo' => false, 'post' => $post ) ); if ( empty( $post_title ) ) - $post_title = $previous ? __('Previous Post') : __('Next Post'); + $post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); - $date = mysql2date(get_option('date_format'), $post->post_date); + $date = mysql2date( get_option( 'date_format' ), $post->post_date ); - $title = str_replace('%title', $post_title, $title); - $title = str_replace('%date', $date, $title); + $title = str_replace( '%title', $post_title, $title ); + $title = str_replace( '%date', $date, $title ); $link = $previous ? "\n"; + $link .= "' href='" . get_permalink( $post ) . "' />\n"; $adjacent = $previous ? 'previous' : 'next'; + + /** + * Filter the adjacent post relational link. + * + * The dynamic portion of the hook name, $adjacent, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 2.8.0 + * + * @param string $link The relational link. + */ return apply_filters( "{$adjacent}_post_rel_link", $link ); } @@ -1243,13 +1637,14 @@ function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $ex * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. + * @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 $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ -function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') { - echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', true); - echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', false); +function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); + echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); } /** @@ -1260,8 +1655,9 @@ function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $exclu * */ function adjacent_posts_rel_link_wp_head() { - if ( !is_singular() || is_attachment() ) + if ( ! is_single() || is_attachment() ) { return; + } adjacent_posts_rel_link(); } @@ -1270,12 +1666,13 @@ function adjacent_posts_rel_link_wp_head() { * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. + * @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 $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ -function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') { - echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', false); +function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); } /** @@ -1283,104 +1680,157 @@ function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_c * * @since 2.8.0 * - * @param string $title Optional. Link title format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. + * @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. Default true. + * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ -function prev_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') { - echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', true); +function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); } /** * Retrieve boundary post. * * Boundary being either the first or last post by publish date within the constraints specified - * by $in_same_cat or $excluded_categories. + * by $in_same_term or $excluded_terms. * * @since 2.8.0 * - * @param bool $in_same_cat Optional. Whether returned post should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @param bool $start Optional. Whether to retrieve first or last post. - * @return object + * @param bool $in_same_term Optional. Whether returned 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 $start Optional. Whether to retrieve first or last post. + * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return mixed Array containing the boundary post object if successful, null otherwise. */ -function get_boundary_post( $in_same_cat = false, $excluded_categories = '', $start = true ) { +function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) { $post = get_post(); - if ( ! $post || ! is_single() || is_attachment() ) + if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) return null; - $cat_array = array(); - if( ! is_array( $excluded_categories ) ) - $excluded_categories = explode( ',', $excluded_categories ); + $query_args = array( + 'posts_per_page' => 1, + 'order' => $start ? 'ASC' : 'DESC', + 'update_post_term_cache' => false, + 'update_post_meta_cache' => false + ); + + $term_array = array(); + + if ( ! is_array( $excluded_terms ) ) { + if ( ! empty( $excluded_terms ) ) + $excluded_terms = explode( ',', $excluded_terms ); + else + $excluded_terms = array(); + } - if ( $in_same_cat || ! empty( $excluded_categories ) ) { - if ( $in_same_cat ) - $cat_array = wp_get_object_terms( $post->ID, 'category', array( 'fields' => 'ids' ) ); + if ( $in_same_term || ! empty( $excluded_terms ) ) { + if ( $in_same_term ) + $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); - if ( ! empty( $excluded_categories ) ) { - $excluded_categories = array_map( 'intval', $excluded_categories ); - $excluded_categories = array_diff( $excluded_categories, $cat_array ); + if ( ! empty( $excluded_terms ) ) { + $excluded_terms = array_map( 'intval', $excluded_terms ); + $excluded_terms = array_diff( $excluded_terms, $term_array ); - $inverse_cats = array(); - foreach ( $excluded_categories as $excluded_category ) - $inverse_cats[] = $excluded_category * -1; - $excluded_categories = $inverse_cats; + $inverse_terms = array(); + foreach ( $excluded_terms as $excluded_term ) + $inverse_terms[] = $excluded_term * -1; + $excluded_terms = $inverse_terms; } - } - $categories = implode( ',', array_merge( $cat_array, $excluded_categories ) ); + $query_args[ 'tax_query' ] = array( array( + 'taxonomy' => $taxonomy, + 'terms' => array_merge( $term_array, $excluded_terms ) + ) ); + } - $order = $start ? 'ASC' : 'DESC'; + return get_posts( $query_args ); +} - return get_posts( array('numberposts' => 1, 'category' => $categories, 'order' => $order, 'update_post_term_cache' => false, 'update_post_meta_cache' => false) ); +/* + * Get 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 $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return string + */ +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. * * @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 $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' ) { + echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); +} + +/** + * Get next post link that is adjacent to the current post. * - * @param string $format Optional. Link anchor format. - * @param string $link Optional. Link permalink format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. + * @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 $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. + * @return string */ -function previous_post_link($format='« %link', $link='%title', $in_same_cat = false, $excluded_categories = '') { - adjacent_post_link($format, $link, $in_same_cat, $excluded_categories, true); +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. * * @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_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. + * @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 $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'. */ -function next_post_link($format='%link »', $link='%title', $in_same_cat = false, $excluded_categories = '') { - adjacent_post_link($format, $link, $in_same_cat, $excluded_categories, false); +function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { + echo get_next_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); } /** - * Display adjacent post link. + * Get adjacent post link. * * Can be either next post link or previous. * - * @since 2.5.0 + * @since 3.7.0 * - * @param string $format Link anchor format. - * @param string $link Link permalink format. - * @param bool $in_same_cat Optional. Whether link should be in a same category. - * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs. - * @param bool $previous Optional, default is true. Whether to display link to previous or next post. + * @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 $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_cat = false, $excluded_categories = '', $previous = true ) { +function get_adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { if ( $previous && is_attachment() ) $post = get_post( get_post()->post_parent ); else - $post = get_adjacent_post( $in_same_cat, $excluded_categories, $previous ); + $post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); if ( ! $post ) { $output = ''; @@ -1390,7 +1840,9 @@ function adjacent_post_link( $format, $link, $in_same_cat = false, $excluded_cat if ( empty( $post->post_title ) ) $title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); + /** This filter is documented in wp-includes/post-template.php */ $title = apply_filters( 'the_title', $title, $post->ID ); + $date = mysql2date( get_option( 'date_format' ), $post->post_date ); $rel = $previous ? 'prev' : 'next'; @@ -1404,7 +1856,40 @@ function adjacent_post_link( $format, $link, $in_same_cat = false, $excluded_cat $adjacent = $previous ? 'previous' : 'next'; - echo apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post ); + /** + * Filter the adjacent post link. + * + * The dynamic portion of the hook name, $adjacent, refers to the type + * of adjacency, 'next' or 'previous'. + * + * @since 2.6.0 + * + * @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. + */ + return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post ); +} + +/** + * Display 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 $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 ); } /** @@ -1466,7 +1951,14 @@ function get_pagenum_link($pagenum = 1, $escape = true ) { $result = $base . $request . $query_string; } - $result = apply_filters('get_pagenum_link', $result); + /** + * Filter the page number link for the current request. + * + * @since 2.5.0 + * + * @param string $result The page number link. + */ + $result = apply_filters( 'get_pagenum_link', $result ); if ( $escape ) return esc_url( $result ); @@ -1537,7 +2029,15 @@ function get_next_posts_link( $label = null, $max_page = 0 ) { $label = __( 'Next Page »' ); if ( !is_single() && ( $nextpage <= $max_page ) ) { + /** + * Filter the anchor tag attributes for the next posts page link. + * + * @since 2.7.0 + * + * @param string $attributes Attributes for the anchor tag. + */ $attr = apply_filters( 'next_posts_link_attributes', '' ); + return '" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) . ''; } } @@ -1608,6 +2108,13 @@ function get_previous_posts_link( $label = null ) { $label = __( '« Previous Page' ); if ( !is_single() && $paged > 1 ) { + /** + * Filter the anchor tag attributes for the previous posts page link. + * + * @since 2.7.0 + * + * @param string $attributes Attributes for the anchor tag. + */ $attr = apply_filters( 'previous_posts_link_attributes', '' ); return '". preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) .''; } @@ -1628,7 +2135,7 @@ function previous_posts_link( $label = null ) { /** * Return post pages link navigation for previous and next pages. * - * @since 2.8 + * @since 2.8.0 * * @param string|array $args Optional args. * @return string The posts link navigation. @@ -1709,7 +2216,14 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { $result .= '#comments'; - $result = apply_filters('get_comments_pagenum_link', $result); + /** + * Filter 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; } @@ -1745,6 +2259,13 @@ function get_next_comments_link( $label = '', $max_page = 0 ) { if ( empty($label) ) $label = __('Newer Comments »'); + /** + * Filter the anchor tag attributes for the next comments page link. + * + * @since 2.7.0 + * + * @param string $attributes Attributes for the anchor tag. + */ return ''. preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .''; } @@ -1782,6 +2303,13 @@ function get_previous_comments_link( $label = '' ) { if ( empty($label) ) $label = __('« Older Comments'); + /** + * Filter the anchor tag attributes for the previous comments page link. + * + * @since 2.7.0 + * + * @param string $attributes Attributes for the anchor tag. + */ return '' . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .''; } @@ -1863,7 +2391,14 @@ function get_shortcut_link() { $link = str_replace(array("\r", "\n", "\t"), '', $link); - return apply_filters('shortcut_link', $link); + /** + * Filter the Press This bookmarklet link. + * + * @since 2.6.0 + * + * @param string $link The Press This bookmarklet link. + */ + return apply_filters( 'shortcut_link', $link ); } /** @@ -1873,7 +2408,6 @@ function get_shortcut_link() { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress * @since 3.0.0 * * @uses get_home_url() @@ -1893,7 +2427,6 @@ function home_url( $path = '', $scheme = null ) { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress * @since 3.0.0 * * @param int $blog_id (optional) Blog ID. Defaults to current blog. @@ -1913,7 +2446,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { } if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) { - if ( is_ssl() && ! is_admin() ) + if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] ) $scheme = 'https'; else $scheme = parse_url( $url, PHP_URL_SCHEME ); @@ -1924,6 +2457,16 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { if ( $path && is_string( $path ) ) $url .= '/' . ltrim( $path, '/' ); + /** + * Filter 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. + */ return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); } @@ -1934,8 +2477,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress - * @since 2.6.0 + * @since 3.0.0 * * @uses get_site_url() * @@ -1954,7 +2496,6 @@ function site_url( $path = '', $scheme = null ) { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress * @since 3.0.0 * * @param int $blog_id (optional) Blog ID. Defaults to current blog. @@ -1976,13 +2517,23 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) { if ( $path && is_string( $path ) ) $url .= '/' . ltrim( $path, '/' ); + /** + * Filter the site URL. + * + * @since 2.7.0 + * + * @param string $url The complete site URL including scheme and path. + * @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. + */ return apply_filters( 'site_url', $url, $path, $scheme, $blog_id ); } /** * Retrieve the url to the admin area for the current site. * - * @package WordPress * @since 2.6.0 * * @param string $path Optional path relative to the admin url. @@ -1996,7 +2547,6 @@ function admin_url( $path = '', $scheme = 'admin' ) { /** * Retrieve the url to the admin area for a given site. * - * @package WordPress * @since 3.0.0 * * @param int $blog_id (optional) Blog ID. Defaults to current blog. @@ -2010,13 +2560,21 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { if ( $path && is_string( $path ) ) $url .= ltrim( $path, '/' ); + /** + * Filter 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. + */ return apply_filters( 'admin_url', $url, $path, $blog_id ); } /** * Retrieve the url to the includes directory. * - * @package WordPress * @since 2.6.0 * * @param string $path Optional. Path relative to the includes url. @@ -2029,13 +2587,21 @@ function includes_url( $path = '', $scheme = null ) { if ( $path && is_string( $path ) ) $url .= ltrim($path, '/'); - return apply_filters('includes_url', $url, $path); + /** + * Filter the URL to the includes directory. + * + * @since 2.8.0 + * + * @param string $url The complete URL to the includes directory including scheme and path. + * @param string $path Path relative to the URL to the wp-includes directory. Blank string + * if no path is specified. + */ + return apply_filters( 'includes_url', $url, $path ); } /** * Retrieve the url to the content directory. * - * @package WordPress * @since 2.6.0 * * @param string $path Optional. Path relative to the content url. @@ -2047,27 +2613,37 @@ function content_url($path = '') { if ( $path && is_string( $path ) ) $url .= '/' . ltrim($path, '/'); - return apply_filters('content_url', $url, $path); + /** + * Filter the URL to the content directory. + * + * @since 2.8.0 + * + * @param string $url The complete URL to the content directory including scheme and path. + * @param string $path Path relative to the URL to the content directory. Blank string + * if no path is specified. + */ + return apply_filters( 'content_url', $url, $path); } /** - * Retrieve the url to the plugins directory or to a specific file within that directory. - * You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name. + * Retrieve a URL within the plugins or mu-plugins directory. + * + * Defaults to the plugins directory URL if no arguments are supplied. * - * @package WordPress * @since 2.6.0 * - * @param string $path Optional. Path relative to the plugins url. - * @param string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__ - * @return string Plugins url link with optional path appended. + * @param string $path Optional. Extra path appended to the end of the URL, including + * the relative directory if $plugin is supplied. Default empty. + * @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin. + * 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 = '') { +function plugins_url( $path = '', $plugin = '' ) { - $mu_plugin_dir = WPMU_PLUGIN_DIR; - foreach ( array('path', 'plugin', 'mu_plugin_dir') as $var ) { - $$var = str_replace('\\' ,'/', $$var); // sanitize for Win32 installs - $$var = preg_replace('|/+|', '/', $$var); - } + $path = wp_normalize_path( $path ); + $plugin = wp_normalize_path( $plugin ); + $mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR ); if ( !empty($plugin) && 0 === strpos($plugin, $mu_plugin_dir) ) $url = WPMU_PLUGIN_URL; @@ -2086,7 +2662,18 @@ function plugins_url($path = '', $plugin = '') { if ( $path && is_string( $path ) ) $url .= '/' . ltrim($path, '/'); - return apply_filters('plugins_url', $url, $path, $plugin); + /** + * Filter the URL to the plugins directory. + * + * @since 2.8.0 + * + * @param string $url The complete URL to the plugins directory including scheme and path. + * @param string $path Path relative to the URL to the plugins directory. Blank string + * if no path is specified. + * @param string $plugin The plugin file path to be relative to. Blank string if no plugin + * is specified. + */ + return apply_filters( 'plugins_url', $url, $path, $plugin ); } /** @@ -2096,7 +2683,6 @@ function plugins_url($path = '', $plugin = '') { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress * @since 3.0.0 * * @param string $path Optional. Path relative to the site url. @@ -2104,11 +2690,11 @@ function plugins_url($path = '', $plugin = '') { * @return string Site url link with optional path appended. */ function network_site_url( $path = '', $scheme = null ) { - global $current_site; - if ( ! is_multisite() ) return site_url($path, $scheme); + $current_site = get_current_site(); + if ( 'relative' == $scheme ) $url = $current_site->path; else @@ -2117,6 +2703,17 @@ function network_site_url( $path = '', $scheme = null ) { if ( $path && is_string( $path ) ) $url .= ltrim( $path, '/' ); + /** + * Filter the network site URL. + * + * @since 3.0.0 + * + * @param string $url The complete network site URL including scheme and path. + * @param string $path Path relative to the network site URL. Blank string if + * no path is specified. + * @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https', + * 'relative' or null. + */ return apply_filters( 'network_site_url', $url, $path, $scheme ); } @@ -2127,7 +2724,6 @@ function network_site_url( $path = '', $scheme = null ) { * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is * overridden. * - * @package WordPress * @since 3.0.0 * * @param string $path (optional) Path relative to the home url. @@ -2135,11 +2731,10 @@ function network_site_url( $path = '', $scheme = null ) { * @return string Home url link with optional path appended. */ function network_home_url( $path = '', $scheme = null ) { - global $current_site; - if ( ! is_multisite() ) return home_url($path, $scheme); + $current_site = get_current_site(); $orig_scheme = $scheme; if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) @@ -2153,13 +2748,23 @@ function network_home_url( $path = '', $scheme = null ) { if ( $path && is_string( $path ) ) $url .= ltrim( $path, '/' ); + /** + * Filter the network home URL. + * + * @since 3.0.0 + * + * @param string $url The complete network home URL including scheme and path. + * @param string $path Path relative to the network home URL. Blank string + * if no path is specified. + * @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https', + * 'relative' or null. + */ return apply_filters( 'network_home_url', $url, $path, $orig_scheme); } /** * Retrieve the url to the admin area for the network. * - * @package WordPress * @since 3.0.0 * * @param string $path Optional path relative to the admin url. @@ -2175,13 +2780,21 @@ function network_admin_url( $path = '', $scheme = 'admin' ) { if ( $path && is_string( $path ) ) $url .= ltrim($path, '/'); - return apply_filters('network_admin_url', $url, $path); + /** + * Filter the network admin URL. + * + * @since 3.0.0 + * + * @param string $url The complete network admin URL including scheme and path. + * @param string $path Path relative to the network admin URL. Blank string if + * no path is specified. + */ + return apply_filters( 'network_admin_url', $url, $path ); } /** * Retrieve the url to the admin area for the current user. * - * @package WordPress * @since 3.0.0 * * @param string $path Optional path relative to the admin url. @@ -2194,13 +2807,21 @@ function user_admin_url( $path = '', $scheme = 'admin' ) { if ( $path && is_string( $path ) ) $url .= ltrim($path, '/'); - return apply_filters('user_admin_url', $url, $path); + /** + * Filter the user admin URL for the current user. + * + * @since 3.1.0 + * + * @param string $url The complete URL including scheme and path. + * @param string $path Path relative to the URL. Blank string if + * no path is specified. + */ + return apply_filters( 'user_admin_url', $url, $path ); } /** * Retrieve the url to the admin area for either the current blog or the network depending on context. * - * @package WordPress * @since 3.1.0 * * @param string $path Optional path relative to the admin url. @@ -2227,22 +2848,37 @@ function self_admin_url($path = '', $scheme = 'admin') { */ function set_url_scheme( $url, $scheme = null ) { $orig_scheme = $scheme; - if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) { - if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) ) - $scheme = 'https'; - elseif ( ( 'login' == $scheme ) && force_ssl_admin() ) - $scheme = 'https'; - elseif ( ( 'admin' == $scheme ) && force_ssl_admin() ) - $scheme = 'https'; - else - $scheme = ( is_ssl() ? 'https' : 'http' ); + + if ( ! $scheme ) { + $scheme = is_ssl() ? 'https' : 'http'; + } elseif ( $scheme === 'admin' || $scheme === 'login' || $scheme === 'login_post' || $scheme === 'rpc' ) { + $scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http'; + } elseif ( $scheme !== 'http' && $scheme !== 'https' && $scheme !== 'relative' ) { + $scheme = is_ssl() ? 'https' : 'http'; } - if ( 'relative' == $scheme ) - $url = preg_replace( '#^.+://[^/]*#', '', $url ); - else - $url = preg_replace( '#^.+://#', $scheme . '://', $url ); + $url = trim( $url ); + if ( substr( $url, 0, 2 ) === '//' ) + $url = 'http:' . $url; + if ( 'relative' == $scheme ) { + $url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) ); + if ( $url !== '' && $url[0] === '/' ) + $url = '/' . ltrim($url , "/ \t\n\r\0\x0B" ); + } else { + $url = preg_replace( '#^\w+://#', $scheme . '://', $url ); + } + + /** + * Filter 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'. + */ return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme ); } @@ -2255,13 +2891,13 @@ function set_url_scheme( $url, $scheme = null ) { * * @since 3.1.0 * - * @param int $user_id User ID + * @param int $user_id Optional. User ID. Defaults to current user. * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins. * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. * @return string Dashboard url link with optional path appended. */ -function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) { - $user_id = (int) $user_id; +function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) { + $user_id = $user_id ? (int) $user_id : get_current_user_id(); $blogs = get_blogs_of_user( $user_id ); if ( ! is_super_admin() && empty($blogs) ) { @@ -2281,6 +2917,17 @@ function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) { } } + /** + * Filter the dashboard URL for a user. + * + * @since 3.1.0 + * + * @param string $url The complete URL including scheme and path. + * @param int $user_id The user ID. + * @param string $path Path relative to the URL. Blank string if no path is specified. + * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', + * 'login_post', 'admin', 'relative' or null. + */ return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme); } @@ -2289,27 +2936,37 @@ function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) { * * @since 3.1.0 * - * @param int $user User ID - * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. + * @param int $user_id Optional. User ID. Defaults to current user. + * @param string $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_edit_profile_url( $user, $scheme = 'admin' ) { - $user = (int) $user; +function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { + $user_id = $user_id ? (int) $user_id : get_current_user_id(); if ( is_user_admin() ) $url = user_admin_url( 'profile.php', $scheme ); elseif ( is_network_admin() ) $url = network_admin_url( 'profile.php', $scheme ); else - $url = get_dashboard_url( $user, 'profile.php', $scheme ); + $url = get_dashboard_url( $user_id, 'profile.php', $scheme ); - return apply_filters( 'edit_profile_url', $url, $user, $scheme); + /** + * Filter the URL for a user's profile editor. + * + * @since 3.1.0 + * + * @param string $url The complete URL including scheme and path. + * @param int $user_id The user ID. + * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', + * 'login_post', 'admin', 'relative' or null. + */ + return apply_filters( 'edit_profile_url', $url, $user_id, $scheme); } /** * Output rel=canonical for singular queries. * - * @package WordPress * @since 2.9.0 */ function rel_canonical() { @@ -2344,30 +3001,59 @@ function rel_canonical() { * @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) { - // Allow plugins to short-circuit this function. - $shortlink = apply_filters('pre_get_shortlink', false, $id, $context, $allow_slugs); + /** + * Filter 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. + * + * @since 3.0.0 + * + * @param bool|string $return Short-circuit return value. Either false or a URL string. + * @param int $id Post ID, or 0 for the current post. + * @param string $context The context for the link. One of 'post' or 'query', + * @param bool $allow_slugs Whether to allow post slugs in the shortlink. + */ + $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs ); + if ( false !== $shortlink ) return $shortlink; global $wp_query; $post_id = 0; - if ( 'query' == $context && is_single() ) { + if ( 'query' == $context && is_singular() ) { $post_id = $wp_query->get_queried_object_id(); + $post = get_post( $post_id ); } elseif ( 'post' == $context ) { - $post = get_post($id); - $post_id = $post->ID; + $post = get_post( $id ); + if ( ! empty( $post->ID ) ) + $post_id = $post->ID; } $shortlink = ''; - // Return p= link for posts. - if ( !empty($post_id) && '' != get_option('permalink_structure') ) { - $post = get_post($post_id); - if ( isset($post->post_type) && 'post' == $post->post_type ) - $shortlink = home_url('?p=' . $post->ID); + // Return p= link for all public post types. + if ( ! empty( $post_id ) ) { + $post_type = get_post_type_object( $post->post_type ); + + if ( 'page' === $post->post_type && $post->ID == get_option( 'page_on_front' ) && 'page' == get_option( 'show_on_front' ) ) { + $shortlink = home_url( '/' ); + } elseif ( $post_type->public ) { + $shortlink = home_url( '?p=' . $post_id ); + } } - return apply_filters('get_shortlink', $shortlink, $id, $context, $allow_slugs); + /** + * Filter the shortlink for a post. + * + * @since 3.0.0 + * + * @param string $shortlink Shortlink URL. + * @param int $id Post ID, or 0 for the current post. + * @param string $context The context for the link. One of 'post' or 'query', + * @param bool $allow_slugs Whether to allow post slugs in the shortlink. Not used by default. + */ + return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs ); } /** @@ -2436,6 +3122,17 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { if ( !empty( $shortlink ) ) { $link = '' . $text . ''; + + /** + * Filter the shortlink anchor tag for a post. + * + * @since 3.0.0 + * + * @param string $link Shortlink anchor tag. + * @param string $shortlink Shortlink URL. + * @param string $text Shortlink's text. + * @param string $title Shortlink's title attribute. + */ $link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title ); echo $before, $link, $after; }