<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[28111] trunk/src/wp-includes/link-template.php: Inline documentation for hooks in wp-includes/link-template.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28111">28111</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-04-14 02:12:48 +0000 (Mon, 14 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/link-template.php.
Props johnbillion, DrewAPicture.
Fixes <a href="http://core.trac.wordpress.org/ticket/27716">#27716</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/link-template.php (28110 => 28111)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/link-template.php 2014-04-14 00:40:45 UTC (rev 28110)
+++ trunk/src/wp-includes/link-template.php 2014-04-14 02:12:48 UTC (rev 28111)
</span><span class="lines">@@ -10,9 +10,15 @@
</span><span class="cx"> * Display the permalink for the current post.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><del>- * @uses apply_filters() Calls 'the_permalink' filter on the permalink string.
</del><span class="cx"> */
</span><span class="cx"> function the_permalink() {
</span><ins>+ /**
+ * Filter the display of the permalink for the current post.
+ *
+ * @since 1.5.0
+ *
+ * @param string $permalink The permalink for the current post.
+ */
</ins><span class="cx"> echo esc_url( apply_filters( 'the_permalink', get_permalink() ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -38,9 +44,18 @@
</span><span class="cx"> else
</span><span class="cx"> $string = untrailingslashit($string);
</span><span class="cx">
</span><del>- // 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);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> return $string;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -129,7 +144,18 @@
</span><span class="cx">
</span><span class="cx"> $permalink = get_option('permalink_structure');
</span><span class="cx">
</span><del>- $permalink = apply_filters('pre_post_link', $permalink, $post, $leavename);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> if ( '' != $permalink && !in_array($post->post_status, array('draft', 'pending', 'auto-draft')) ) {
</span><span class="cx"> $unixtime = strtotime($post->post_date);
</span><span class="lines">@@ -139,7 +165,18 @@
</span><span class="cx"> $cats = get_the_category($post->ID);
</span><span class="cx"> if ( $cats ) {
</span><span class="cx"> usort($cats, '_usort_terms_by_ID'); // order by ID
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post );
</span><ins>+
</ins><span class="cx"> $category_object = get_term( $category_object, 'category' );
</span><span class="cx"> $category = $category_object->slug;
</span><span class="cx"> if ( $parent = $category_object->parent )
</span><span class="lines">@@ -179,7 +216,19 @@
</span><span class="cx"> } else { // if they're not using the fancy permalink option
</span><span class="cx"> $permalink = home_url('?p=' . $post->ID);
</span><span class="cx"> }
</span><del>- return apply_filters('post_link', $permalink, $post, $leavename);
</del><ins>+
+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -223,7 +272,17 @@
</span><span class="cx"> $post_link = home_url($post_link);
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return apply_filters('post_type_link', $post_link, $post, $leavename, $sample);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -262,6 +321,15 @@
</span><span class="cx"> else
</span><span class="cx"> $link = _get_page_link( $post, $leavename, $sample );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'page_link', $link, $post->ID, $sample );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -298,6 +366,14 @@
</span><span class="cx"> $link = home_url( '?page_id=' . $post->ID );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( '_get_page_link', $link, $post->ID );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -341,6 +417,14 @@
</span><span class="cx"> if ( ! $link )
</span><span class="cx"> $link = home_url( '/?attachment_id=' . $post->ID );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the permalink for an attachment.
+ *
+ * @since 2.0.0
+ *
+ * @param string $link The attachment's permalink.
+ * @param int $post_id Attachment ID.
+ */
</ins><span class="cx"> return apply_filters( 'attachment_link', $link, $post->ID );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -359,10 +443,20 @@
</span><span class="cx"> $yearlink = $wp_rewrite->get_year_permastruct();
</span><span class="cx"> if ( !empty($yearlink) ) {
</span><span class="cx"> $yearlink = str_replace('%year%', $year, $yearlink);
</span><del>- return apply_filters('year_link', home_url( user_trailingslashit($yearlink, 'year') ), $year);
</del><ins>+ $yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) );
</ins><span class="cx"> } else {
</span><del>- return apply_filters('year_link', home_url('?m=' . $year), $year);
</del><ins>+ $yearlink = home_url( '?m=' . $year );
</ins><span class="cx"> }
</span><ins>+
+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -384,10 +478,21 @@
</span><span class="cx"> if ( !empty($monthlink) ) {
</span><span class="cx"> $monthlink = str_replace('%year%', $year, $monthlink);
</span><span class="cx"> $monthlink = str_replace('%monthnum%', zeroise(intval($month), 2), $monthlink);
</span><del>- return apply_filters('month_link', home_url( user_trailingslashit($monthlink, 'month') ), $year, $month);
</del><ins>+ $monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) );
</ins><span class="cx"> } else {
</span><del>- return apply_filters('month_link', home_url( '?m=' . $year . zeroise($month, 2) ), $year, $month);
</del><ins>+ $monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) );
</ins><span class="cx"> }
</span><ins>+
+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -414,10 +519,22 @@
</span><span class="cx"> $daylink = str_replace('%year%', $year, $daylink);
</span><span class="cx"> $daylink = str_replace('%monthnum%', zeroise(intval($month), 2), $daylink);
</span><span class="cx"> $daylink = str_replace('%day%', zeroise(intval($day), 2), $daylink);
</span><del>- return apply_filters('day_link', home_url( user_trailingslashit($daylink, 'day') ), $year, $month, $day);
</del><ins>+ $daylink = home_url( user_trailingslashit( $daylink, 'day' ) );
</ins><span class="cx"> } else {
</span><del>- return apply_filters('day_link', home_url( '?m=' . $year . zeroise($month, 2) . zeroise($day, 2) ), $year, $month, $day);
</del><ins>+ $daylink = home_url( '?m=' . $year . zeroise( $month, 2 ) . zeroise( $day, 2 ) );
</ins><span class="cx"> }
</span><ins>+
+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -430,6 +547,16 @@
</span><span class="cx"> */
</span><span class="cx"> function the_feed_link( $anchor, $feed = '' ) {
</span><span class="cx"> $link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> echo apply_filters( 'the_feed_link', $link, $feed );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -467,7 +594,15 @@
</span><span class="cx"> $output = home_url("?feed={$feed}");
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return apply_filters('feed_link', $output, $feed);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -506,7 +641,14 @@
</span><span class="cx"> $url = add_query_arg( array( 'feed' => $feed, 'p' => $post_id ), home_url( '/' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return apply_filters('post_comments_feed_link', $url);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -528,6 +670,15 @@
</span><span class="cx"> if ( empty($link_text) )
</span><span class="cx"> $link_text = __('Comments Feed');
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> echo apply_filters( 'post_comments_feed_link_html', "<a href='$url'>$link_text</a>", $post_id, $feed );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -562,7 +713,15 @@
</span><span class="cx"> $link = trailingslashit($link) . user_trailingslashit($feed_link, 'feed');
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $link = apply_filters('author_feed_link', $link, $feed);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> return $link;
</span><span class="cx"> }
</span><span class="lines">@@ -629,12 +788,38 @@
</span><span class="cx"> $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( 'category' == $taxonomy )
</del><ins>+ if ( 'category' == $taxonomy ) {
+ /**
+ * Filter the category feed link.
+ *
+ * @since 1.5.1
+ *
+ * @param string $link The category feed link.
+ * @param string $feed Feed type.
+ */
</ins><span class="cx"> $link = apply_filters( 'category_feed_link', $link, $feed );
</span><del>- elseif ( 'post_tag' == $taxonomy )
</del><ins>+ } 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.
+ */
</ins><span class="cx"> $link = apply_filters( 'tag_feed_link', $link, $feed );
</span><del>- else
</del><ins>+ } 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.
+ */
</ins><span class="cx"> $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $link;
</span><span class="cx"> }
</span><span class="lines">@@ -662,6 +847,13 @@
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><span class="cx"> function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
</span><ins>+ /**
+ * Filter the edit link for a tag (or term in another taxonomy).
+ *
+ * @since 2.7.0
+ *
+ * @param string $link The term edit link.
+ */
</ins><span class="cx"> return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -678,6 +870,14 @@
</span><span class="cx"> */
</span><span class="cx"> function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
</span><span class="cx"> $link = edit_term_link( $link, '', '', $tag, false );
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> echo $before . apply_filters( 'edit_tag_link', $link ) . $after;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -709,6 +909,16 @@
</span><span class="cx">
</span><span class="cx"> $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
</span><span class="cx">
</span><ins>+ /**
+ * 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).
+ */
</ins><span class="cx"> return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -738,6 +948,15 @@
</span><span class="cx"> $link = __('Edit This');
</span><span class="cx">
</span><span class="cx"> $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after;
</span><span class="cx">
</span><span class="cx"> if ( $echo )
</span><span class="lines">@@ -773,6 +992,14 @@
</span><span class="cx"> $link = home_url( user_trailingslashit( $link, 'search' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter the search permalink.
+ *
+ * @since 3.0.0
+ *
+ * @param string $link Search permalink.
+ * @param string $search The URL-encoded search term.
+ */
</ins><span class="cx"> return apply_filters( 'search_link', $link, $search );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -801,7 +1028,16 @@
</span><span class="cx"> $link .= "feed/$feed/";
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $link = apply_filters('search_feed_link', $link, $feed, 'posts');
</del><ins>+ /**
+ * 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' );
</ins><span class="cx">
</span><span class="cx"> return $link;
</span><span class="cx"> }
</span><span class="lines">@@ -830,6 +1066,7 @@
</span><span class="cx"> else
</span><span class="cx"> $link = add_query_arg('withcomments', 1, $link);
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/link-template.php */
</ins><span class="cx"> $link = apply_filters('search_feed_link', $link, $feed, 'comments');
</span><span class="cx">
</span><span class="cx"> return $link;
</span><span class="lines">@@ -862,6 +1099,14 @@
</span><span class="cx"> $link = home_url( '?post_type=' . $post_type );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'post_type_archive_link', $link, $post_type );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -892,6 +1137,14 @@
</span><span class="cx"> $link = add_query_arg( 'feed', $feed, $link );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'post_type_archive_feed_link', $link, $feed );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -925,7 +1178,17 @@
</span><span class="cx"> if ( !current_user_can( 'edit_post', $post->ID ) )
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- return apply_filters( 'get_edit_post_link', admin_url( sprintf($post_type_object->_edit_link . $action, $post->ID) ), $post->ID, $context );
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -950,6 +1213,15 @@
</span><span class="cx">
</span><span class="cx"> $post_type_obj = get_post_type_object( $post->post_type );
</span><span class="cx"> $link = '<a class="post-edit-link" href="' . $url . '">' . $link . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> echo $before . apply_filters( 'edit_post_link', $link, $post->ID ) . $after;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -983,6 +1255,15 @@
</span><span class="cx">
</span><span class="cx"> $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1001,6 +1282,14 @@
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> $location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID;
</span><ins>+
+ /**
+ * Filter the comment edit link.
+ *
+ * @since 2.3.0
+ *
+ * @param string $location The edit link.
+ */
</ins><span class="cx"> return apply_filters( 'get_edit_comment_link', $location );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1023,6 +1312,15 @@
</span><span class="cx"> $link = __('Edit This');
</span><span class="cx">
</span><span class="cx"> $link = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '">' . $link . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1041,6 +1339,15 @@
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> $location = admin_url('link.php?action=edit&link_id=') . $link->link_id;
</span><ins>+
+ /**
+ * Filter the bookmark (link) edit link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $location The edit link.
+ * @param int $link_id Bookmark ID.
+ */
</ins><span class="cx"> return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1064,6 +1371,15 @@
</span><span class="cx"> $link = __('Edit This');
</span><span class="cx">
</span><span class="cx"> $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '">' . $link . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1092,6 +1408,14 @@
</span><span class="cx"> else
</span><span class="cx"> $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the user edit link.
+ *
+ * @since 3.5.0
+ *
+ * @param string $link The edit link.
+ * @param int $user_id User ID.
+ */
</ins><span class="cx"> return apply_filters( 'get_edit_user_link', $link, $user->ID );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1189,8 +1513,44 @@
</span><span class="cx"> $op = $previous ? '<' : '>';
</span><span class="cx"> $order = $previous ? 'DESC' : 'ASC';
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms );
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $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_terms_sql", $current_post_date, $post->post_type), $in_same_term, $excluded_terms );
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" );
</span><span class="cx">
</span><span class="cx"> $query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort";
</span><span class="lines">@@ -1252,6 +1612,17 @@
</span><span class="cx"> $link .= "' href='" . get_permalink( $post ) . "' />\n";
</span><span class="cx">
</span><span class="cx"> $adjacent = $previous ? 'previous' : 'next';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( "{$adjacent}_post_rel_link", $link );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1464,6 +1835,7 @@
</span><span class="cx">
</span><span class="cx"> /** This filter is documented in wp-includes/post-template.php */
</span><span class="cx"> $title = apply_filters( 'the_title', $title, $post->ID );
</span><ins>+
</ins><span class="cx"> $date = mysql2date( get_option( 'date_format' ), $post->post_date );
</span><span class="cx"> $rel = $previous ? 'prev' : 'next';
</span><span class="cx">
</span><span class="lines">@@ -1477,6 +1849,19 @@
</span><span class="cx">
</span><span class="cx"> $adjacent = $previous ? 'previous' : 'next';
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1559,7 +1944,14 @@
</span><span class="cx"> $result = $base . $request . $query_string;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $result = apply_filters('get_pagenum_link', $result);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> if ( $escape )
</span><span class="cx"> return esc_url( $result );
</span><span class="lines">@@ -1630,7 +2022,15 @@
</span><span class="cx"> $label = __( 'Next Page »' );
</span><span class="cx">
</span><span class="cx"> if ( !is_single() && ( $nextpage <= $max_page ) ) {
</span><ins>+ /**
+ * Filter the anchor tag attributes for the next posts page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
</ins><span class="cx"> $attr = apply_filters( 'next_posts_link_attributes', '' );
</span><ins>+
</ins><span class="cx"> return '<a href="' . next_posts( $max_page, false ) . "\" $attr>" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) . '</a>';
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -1701,6 +2101,13 @@
</span><span class="cx"> $label = __( '« Previous Page' );
</span><span class="cx">
</span><span class="cx"> if ( !is_single() && $paged > 1 ) {
</span><ins>+ /**
+ * Filter the anchor tag attributes for the previous posts page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
</ins><span class="cx"> $attr = apply_filters( 'previous_posts_link_attributes', '' );
</span><span class="cx"> return '<a href="' . previous_posts( false ) . "\" $attr>". preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) .'</a>';
</span><span class="cx"> }
</span><span class="lines">@@ -1802,7 +2209,14 @@
</span><span class="cx">
</span><span class="cx"> $result .= '#comments';
</span><span class="cx">
</span><del>- $result = apply_filters('get_comments_pagenum_link', $result);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> return $result;
</span><span class="cx"> }
</span><span class="lines">@@ -1838,6 +2252,13 @@
</span><span class="cx"> if ( empty($label) )
</span><span class="cx"> $label = __('Newer Comments »');
</span><span class="cx">
</span><ins>+ /**
+ * Filter the anchor tag attributes for the next comments page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
</ins><span class="cx"> return '<a href="' . esc_url( get_comments_pagenum_link( $nextpage, $max_page ) ) . '" ' . apply_filters( 'next_comments_link_attributes', '' ) . '>'. preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .'</a>';
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1875,6 +2296,13 @@
</span><span class="cx"> if ( empty($label) )
</span><span class="cx"> $label = __('« Older Comments');
</span><span class="cx">
</span><ins>+ /**
+ * Filter the anchor tag attributes for the previous comments page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
</ins><span class="cx"> return '<a href="' . esc_url( get_comments_pagenum_link( $prevpage ) ) . '" ' . apply_filters( 'previous_comments_link_attributes', '' ) . '>' . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .'</a>';
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1956,7 +2384,14 @@
</span><span class="cx">
</span><span class="cx"> $link = str_replace(array("\r", "\n", "\t"), '', $link);
</span><span class="cx">
</span><del>- return apply_filters('shortcut_link', $link);
</del><ins>+ /**
+ * Filter the Press This bookmarklet link.
+ *
+ * @since 2.6.0
+ *
+ * @param string $link The Press This bookmarklet link.
+ */
+ return apply_filters( 'shortcut_link', $link );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2015,6 +2450,16 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= '/' . ltrim( $path, '/' );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2025,7 +2470,7 @@
</span><span class="cx"> * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
</span><span class="cx"> * overridden.
</span><span class="cx"> *
</span><del>- * @since 2.6.0
</del><ins>+ * @since 3.0.0
</ins><span class="cx"> *
</span><span class="cx"> * @uses get_site_url()
</span><span class="cx"> *
</span><span class="lines">@@ -2065,6 +2510,17 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= '/' . ltrim( $path, '/' );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2097,6 +2553,15 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim( $path, '/' );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'admin_url', $url, $path, $blog_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2115,7 +2580,16 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim($path, '/');
</span><span class="cx">
</span><del>- return apply_filters('includes_url', $url, $path);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2132,7 +2606,16 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= '/' . ltrim($path, '/');
</span><span class="cx">
</span><del>- return apply_filters('content_url', $url, $path);
</del><ins>+ /**
+ * 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);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2170,7 +2653,18 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= '/' . ltrim($path, '/');
</span><span class="cx">
</span><del>- return apply_filters('plugins_url', $url, $path, $plugin);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2200,6 +2694,17 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim( $path, '/' );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'network_site_url', $url, $path, $scheme );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2234,6 +2739,17 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim( $path, '/' );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'network_home_url', $url, $path, $orig_scheme);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2255,7 +2771,16 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim($path, '/');
</span><span class="cx">
</span><del>- return apply_filters('network_admin_url', $url, $path);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2273,7 +2798,16 @@
</span><span class="cx"> if ( $path && is_string( $path ) )
</span><span class="cx"> $url .= ltrim($path, '/');
</span><span class="cx">
</span><del>- return apply_filters('user_admin_url', $url, $path);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2328,6 +2862,16 @@
</span><span class="cx"> $url = preg_replace( '#^\w+://#', $scheme . '://', $url );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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'.
+ */
</ins><span class="cx"> return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2366,6 +2910,17 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2389,6 +2944,16 @@
</span><span class="cx"> else
</span><span class="cx"> $url = get_dashboard_url( $user_id, 'profile.php', $scheme );
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'edit_profile_url', $url, $user_id, $scheme);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2429,8 +2994,21 @@
</span><span class="cx"> * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
</span><span class="cx"> */
</span><span class="cx"> function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
</span><del>- // Allow plugins to short-circuit this function.
- $shortlink = apply_filters('pre_get_shortlink', false, $id, $context, $allow_slugs);
</del><ins>+ /**
+ * 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 );
+
</ins><span class="cx"> if ( false !== $shortlink )
</span><span class="cx"> return $shortlink;
</span><span class="cx">
</span><span class="lines">@@ -2458,7 +3036,17 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return apply_filters('get_shortlink', $shortlink, $id, $context, $allow_slugs);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -2527,6 +3115,17 @@
</span><span class="cx">
</span><span class="cx"> if ( !empty( $shortlink ) ) {
</span><span class="cx"> $link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>';
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title );
</span><span class="cx"> echo $before, $link, $after;
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>