* 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() {
- echo apply_filters('the_permalink', get_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() ) );
}
/**
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;
}
*
* @param string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'.
*/
-function permalink_anchor($mode = 'id') {
- global $post;
- switch ( strtolower($mode) ) {
+function permalink_anchor( $mode = 'id' ) {
+ $post = get_post();
+ switch ( strtolower( $mode ) ) {
case 'title':
- $title = sanitize_title($post->post_title) . '-' . $post->ID;
+ $title = sanitize_title( $post->post_title ) . '-' . $post->ID;
echo '<a id="'.$title.'"></a>';
break;
case '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) {
+function get_permalink( $id = 0, $leavename = false ) {
$rewritecode = array(
'%year%',
'%monthnum%',
$post = $id;
$sample = true;
} else {
- $post = &get_post($id);
+ $post = get_post($id);
$sample = 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);
+ 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);
$cats = get_the_category($post->ID);
if ( $cats ) {
usort($cats, '_usort_terms_by_ID'); // order by ID
- $category = $cats[0]->slug;
- if ( $parent = $cats[0]->parent )
+
+ /**
+ * 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 )
$category = get_category_parents($parent, false, '/', true) . $category;
}
// 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;
}
}
} 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 );
}
/**
function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
global $wp_rewrite;
- $post = &get_post($id);
+ $post = get_post($id);
if ( is_wp_error( $post ) )
return $post;
$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 );
}
/**
*
* @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
*/
*
* @since 1.5.0
*
- * @param int $id Optional. Post ID.
+ * @param int|object $post Optional. Post ID or object.
* @param bool $leavename Optional, defaults to false. Whether to keep page name.
* @param bool $sample Optional, defaults to false. Is it a sample permalink.
* @return string
*/
-function get_page_link( $id = false, $leavename = false, $sample = false ) {
- global $post;
+function get_page_link( $post = false, $leavename = false, $sample = false ) {
+ $post = get_post( $post );
- $id = (int) $id;
- if ( !$id )
- $id = (int) $post->ID;
-
- if ( 'page' == get_option('show_on_front') && $id == get_option('page_on_front') )
+ if ( 'page' == get_option( 'show_on_front' ) && $post->ID == get_option( 'page_on_front' ) )
$link = home_url('/');
else
- $link = _get_page_link( $id , $leavename, $sample );
+ $link = _get_page_link( $post, $leavename, $sample );
- return apply_filters('page_link', $link, $id, $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 );
}
/**
* @since 2.1.0
* @access private
*
- * @param int $id Optional. Post ID.
+ * @param int|object $post Optional. Post ID or object.
* @param bool $leavename Optional. Leave name.
* @param bool $sample Optional. Sample permalink.
* @return string
*/
-function _get_page_link( $id = false, $leavename = false, $sample = false ) {
- global $post, $wp_rewrite;
+function _get_page_link( $post = false, $leavename = false, $sample = false ) {
+ global $wp_rewrite;
- if ( !$id )
- $id = (int) $post->ID;
- else
- $post = &get_post($id);
+ $post = get_post( $post );
$draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
if ( !empty($link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) {
if ( ! $leavename ) {
- $link = str_replace('%pagename%', get_page_uri($id), $link);
+ $link = str_replace('%pagename%', get_page_uri( $post ), $link);
}
$link = home_url($link);
$link = user_trailingslashit($link, 'page');
} else {
- $link = home_url("?page_id=$id");
+ $link = home_url( '?page_id=' . $post->ID );
}
- return apply_filters( '_get_page_link', $link, $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 );
}
/**
*
* @since 2.0.0
*
- * @param int $id Optional. Post ID.
+ * @param int|object $post Optional. Post ID or object.
+ * @param bool $leavename Optional. Leave name.
* @return string
*/
-function get_attachment_link($id = false) {
- global $post, $wp_rewrite;
+function get_attachment_link( $post = null, $leavename = false ) {
+ global $wp_rewrite;
$link = false;
- if ( ! $id)
- $id = (int) $post->ID;
+ $post = get_post( $post );
+ $parent = ( $post->post_parent > 0 && $post->post_parent != $post->ID ) ? get_post( $post->post_parent ) : false;
- $object = get_post($id);
- if ( $wp_rewrite->using_permalinks() && ($object->post_parent > 0) && ($object->post_parent != $id) ) {
- $parent = get_post($object->post_parent);
+ if ( $wp_rewrite->using_permalinks() && $parent ) {
if ( 'page' == $parent->post_type )
- $parentlink = _get_page_link( $object->post_parent ); // Ignores page_on_front
+ $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front
else
- $parentlink = get_permalink( $object->post_parent );
+ $parentlink = get_permalink( $post->post_parent );
- if ( is_numeric($object->post_name) || false !== strpos(get_option('permalink_structure'), '%category%') )
- $name = 'attachment/' . $
object->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker
+ if ( is_numeric($post->post_name) || false !== strpos(get_option('permalink_structure'), '%category%') )
+ $name = 'attachment/' . $
post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker
else
- $name = $object->post_name;
+ $name = $post->post_name;
if ( strpos($parentlink, '?') === false )
- $link = user_trailingslashit( trailingslashit($parentlink) . $name );
+ $link = user_trailingslashit( trailingslashit($parentlink) . '%postname%' );
+
+ if ( ! $leavename )
+ $link = str_replace( '%postname%', $name, $link );
}
if ( ! $link )
- $link = home_url( "/?attachment_id=$id" );
+ $link = home_url( '/?attachment_id=' . $post->ID );
- return apply_filters('attachment_link', $link, $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 );
}
/**
$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 );
}
/**
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 );
}
/**
$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 );
}
/**
*/
function the_feed_link( $anchor, $feed = '' ) {
$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
+
+ /**
+ * 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 );
}
$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 );
}
/**
} else {
$type = get_post_field('post_type', $post_id);
if ( 'page' == $type )
- $url = home_url("?feed=$feed&page_id=$post_id");
+ $url = add_query_arg( array( 'feed' => $feed, 'page_id' => $post_id ), home_url( '/' ) );
else
- $url = home_url("?feed=$feed&p=$post_id");
+ $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 );
}
/**
* 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.
- * @param int $post_id Optional post ID. Default to current post.
+ * @param int $post_id Optional post ID. Default to current post.
* @param string $feed Optional. Feed format.
* @return string Link to the comment feed for the current post.
*/
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
- $url = get_post_comments_feed_link($post_id, $feed);
+ $url = esc_url( get_post_comments_feed_link( $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', "<a href='$url'>$link_text</a>", $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.
$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;
}
/**
* Retrieve the feed link for a category.
*
- * Returns a link to the feed for all post in a given category. A specific 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.
}
/**
- * Retrieve the feed link for a taxonomy.
+ * Retrieve the feed link for a term.
*
- * Returns a link to the feed for all post in a given term. A specific 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
* @param string $feed Optional. Feed type.
- * @return string Link to the feed for the taxonomy specified by $term_id and $taxonomy.
+ * @return string Link to the feed for the term specified by $term_id and $taxonomy.
*/
function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
- global $wp_rewrite;
-
$term_id = ( int ) $term_id;
$term = get_term( $term_id, $taxonomy );
$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 )
- $link = apply_filters( 'category_feed_link', $link, $feed );
- else
+ } 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 {
+ /**
+ * 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;
}
* @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 ) );
}
* @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;
}
$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 );
}
* @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 = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '" title="' . $link . '">' . $link . '</a>';
+ $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>';
+
+ /**
+ * 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 )
}
/**
-* 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;
$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 );
}
$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;
}
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;
$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 );
}
if ( ! $link = get_post_type_archive_link( $post_type ) )
return false;
+
$post_type_obj = get_post_type_object( $post_type );
- if ( $post_type_obj->rewrite['feeds'] && get_option( 'permalink_structure' ) ) {
- $link = trailingslashit($link);
+ if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) {
+ $link = trailingslashit( $link );
$link .= 'feed/';
if ( $feed != $default_feed )
$link .= "$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 );
}
* @since 2.3.0
*
* @param int $id Optional. Post ID.
- * @param string $context Optional, default to display. How to write the '&', defaults to '&'.
+ * @param string $context Optional, defaults to display. How to write the '&', defaults to '&'.
* @return string
*/
function get_edit_post_link( $id = 0, $context = 'display' ) {
- if ( !$post = &get_post( $id ) )
+ if ( ! $post = get_post( $id ) )
return;
- if ( 'display' == $context )
+ if ( 'revision' === $post->post_type )
+ $action = '';
+ elseif ( 'display' == $context )
$action = '&action=edit';
else
$action = '&action=edit';
if ( !$post_type_object )
return;
- if ( !current_user_can( $post_type_object->cap->edit_post, $post->ID ) )
+ 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 );
}
/**
*
* @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 = '<a class="post-edit-link" href="' . $url . '">' . $text . '</a>';
- $post_type_obj = get_post_type_object( $post->post_type );
- $link = '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr( $post_type_obj->labels->edit_item ) . '">' . $link . '</a>';
- 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;
}
/**
if ( ! empty( $deprecated ) )
_deprecated_argument( __FUNCTION__, '3.0' );
- if ( !$post = &get_post( $id ) )
+ if ( !$post = get_post( $id ) )
return;
$post_type_object = get_post_type_object( $post->post_type );
if ( !$post_type_object )
return;
- if ( !current_user_can( $post_type_object->cap->delete_post, $post->ID ) )
+ if ( !current_user_can( 'delete_post', $post->ID ) )
return;
$action = ( $force_delete || !EMPTY_TRASH_DAYS ) ? 'delete' : 'trash';
$delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) );
- return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-{$post->post_type}_{$post->ID}" ), $post->ID, $force_delete );
+ /**
+ * 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 );
}
/**
* @return string
*/
function get_edit_comment_link( $comment_id = 0 ) {
- $comment = &get_comment( $comment_id );
+ $comment = get_comment( $comment_id );
if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
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 = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '">' . $text . '</a>';
- $link = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '" title="' . esc_attr__( 'Edit comment' ) . '">' . $link . '</a>';
- echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after;
+ /**
+ * 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;
}
/**
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 );
}
if ( empty($link) )
$link = __('Edit This');
- $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '" title="' . esc_attr__( 'Edit Link' ) . '">' . $link . '</a>';
+ $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '">' . $link . '</a>';
+
+ /**
+ * 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;
}
+/**
+ * Retrieve edit user link
+ *
+ * @since 3.5.0
+ *
+ * @param int $user_id Optional. User ID. Defaults to the current user.
+ * @return string URL to edit user page or empty string.
+ */
+function get_edit_user_link( $user_id = null ) {
+ if ( ! $user_id )
+ $user_id = get_current_user_id();
+
+ if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) )
+ return '';
+
+ $user = get_userdata( $user_id );
+
+ if ( ! $user )
+ return '';
+
+ if ( get_current_user_id() == $user->ID )
+ $link = get_edit_profile_url( $user->ID );
+ 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 );
+}
+
// Navigation links
/**
*
* @since 1.5.0
*
- * @param bool $in_same_cat Optional. Whether post should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 );
}
/**
*
* @since 1.5.0
*
- * @param bool $in_same_cat Optional. Whether post should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 );
}
/**
*
* @since 2.5.0
*
- * @param bool $in_same_cat Optional. Whether post should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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) {
- global $post, $wpdb;
+function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
+ global $wpdb;
- if ( empty( $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 ) {
- $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids'));
- $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) ) {
- $excluded_categories = array_map('intval', explode(' and ', $excluded_categories));
- if ( !empty($cat_array) ) {
- $excluded_categories = array_diff($excluded_categories, $cat_array);
- $posts_in_ex_cats_sql = '';
- }
+ 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' ) );
- if ( !empty($excluded_categories) ) {
- $posts_in_ex_cats_sql = " AND tt.taxonomy = 'category' AND tt.term_id NOT IN (" . implode($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 ( ! $term_array || is_wp_error( $term_array ) )
+ return '';
+
+ $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, ',' ) . ') )';
}
}
$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.* FROM $wpdb->posts AS p $join $where $sort";
- $query_key = 'adjacent_post_' . md5($query);
- $result = wp_cache_get($query_key, 'counts');
- if ( false !== $result )
+ $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' );
+ if ( false !== $result ) {
+ if ( $result )
+ $result = get_post( $result );
return $result;
+ }
- $result = $wpdb->get_row("SELECT p.* FROM $wpdb->posts AS p $join $where $sort");
+ $result = $wpdb->get_var( $query );
if ( null === $result )
$result = '';
- wp_cache_set($query_key, $result, 'counts');
+ wp_cache_set( $query_key, $result, 'counts' );
+
+ if ( $result )
+ $result = get_post( $result );
+
return $result;
}
*
* @since 2.8.0
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- * @param bool $previous Optional, default is true. Whether display link to previous 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) {
- if ( $previous && is_attachment() && is_object( $GLOBALS['post'] ) )
- $post = & get_post($GLOBALS['post']->post_parent);
+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;
- if ( empty($post->post_title) )
- $post->post_title = $previous ? __('Previous Post') : __('Next Post');
+ $post_title = the_title_attribute( array( 'echo' => false, 'post' => $post ) );
+
+ if ( empty( $post_title ) )
+ $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->post_title, $title);
- $title = str_replace('%date', $date, $title);
- $title = apply_filters('the_title', $title, $post->ID);
+ $title = str_replace( '%title', $post_title, $title );
+ $title = str_replace( '%date', $date, $title );
$link = $previous ? "<link rel='prev' title='" : "<link rel='next' title='";
$link .= esc_attr( $title );
- $link .= "' href='" . get_permalink($post) . "' />\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 );
}
*
* @since 2.8.0
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 );
}
/**
* Display relational links for the posts adjacent to the current post for single post pages.
*
- * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
+ * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
* @since 3.0.0
*
*/
function adjacent_posts_rel_link_wp_head() {
- if ( !is_singular() || is_attachment() )
+ if ( ! is_single() || is_attachment() ) {
return;
+ }
adjacent_posts_rel_link();
}
*
* @since 2.8.0
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 );
}
/**
*
* @since 2.8.0
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 category 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 same category.
- * @param string $excluded_categories Optional. Excluded categories 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) {
- global $post;
-
- if ( empty($post) || !is_single() || is_attachment() )
+function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
+ $post = get_post();
+ if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) )
return null;
- $cat_array = array();
- $excluded_categories = array();
- if ( !empty($in_same_cat) || !empty($excluded_categories) ) {
- if ( !empty($in_same_cat) ) {
- $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids'));
- }
-
- if ( !empty($excluded_categories) ) {
- $excluded_categories = array_map('intval', explode(',', $excluded_categories));
+ $query_args = array(
+ 'posts_per_page' => 1,
+ 'order' => $start ? 'ASC' : 'DESC',
+ 'update_post_term_cache' => false,
+ 'update_post_meta_cache' => false
+ );
- if ( !empty($cat_array) )
- $excluded_categories = array_diff($excluded_categories, $cat_array);
+ $term_array = array();
- $inverse_cats = array();
- foreach ( $excluded_categories as $excluded_category)
- $inverse_cats[] = $excluded_category * -1;
- $excluded_categories = $inverse_cats;
- }
+ if ( ! is_array( $excluded_terms ) ) {
+ if ( ! empty( $excluded_terms ) )
+ $excluded_terms = explode( ',', $excluded_terms );
+ else
+ $excluded_terms = array();
}
- $categories = implode(',', array_merge($cat_array, $excluded_categories) );
+ 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_terms ) ) {
+ $excluded_terms = array_map( 'intval', $excluded_terms );
+ $excluded_terms = array_diff( $excluded_terms, $term_array );
+
+ $inverse_terms = array();
+ foreach ( $excluded_terms as $excluded_term )
+ $inverse_terms[] = $excluded_term * -1;
+ $excluded_terms = $inverse_terms;
+ }
- $order = $start ? 'ASC' : 'DESC';
+ $query_args[ 'tax_query' ] = array( array(
+ 'taxonomy' => $taxonomy,
+ 'terms' => array_merge( $term_array, $excluded_terms )
+ ) );
+ }
- return get_posts( array('numberposts' => 1, 'category' => $categories, 'order' => $order, 'update_post_term_cache' => false, 'update_post_meta_cache' => false) );
+ return get_posts( $query_args );
}
-/**
- * Get boundary post relational link.
+/*
+ * Get previous post link that is adjacent to the current post.
*
- * Can either be start or end post relational link.
- *
- * @since 2.8.0
+ * @since 3.7.0
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- * @param bool $start Optional, default is true. Whether display link to first or last post.
+ * @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_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) {
- $posts = get_boundary_post($in_same_cat, $excluded_categories, $start);
- // If there is no post stop.
- if ( empty($posts) )
- return;
-
- // Even though we limited get_posts to return only 1 item it still returns an array of objects.
- $post = $posts[0];
-
- if ( empty($post->post_title) )
- $post->post_title = $start ? __('First Post') : __('Last Post');
-
- $date = mysql2date(get_option('date_format'), $post->post_date);
-
- $title = str_replace('%title', $post->post_title, $title);
- $title = str_replace('%date', $date, $title);
- $title = apply_filters('the_title', $title, $post->ID);
-
- $link = $start ? "<link rel='start' title='" : "<link rel='end' title='";
- $link .= esc_attr($title);
- $link .= "' href='" . get_permalink($post) . "' />\n";
-
- $boundary = $start ? 'start' : 'end';
- return apply_filters( "{$boundary}_post_rel_link", $link );
+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 relational link for the first post.
+ * Display previous post link that is adjacent to the current post.
*
- * @since 2.8.0
+ * @since 1.5.0
+ * @see get_previous_post_link()
*
- * @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories 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 start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
- echo get_boundary_post_rel_link($title, $in_same_cat, $excluded_categories, true);
+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 site index relational link.
+ * Get next post link that is adjacent to the current post.
*
- * @since 2.8.0
+ * @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_index_rel_link() {
- $link = "<link rel='index' title='" . esc_attr( get_bloginfo( 'name', 'display' ) ) . "' href='" . esc_url( user_trailingslashit( get_bloginfo( 'url', 'display' ) ) ) . "' />\n";
- return apply_filters( "index_rel_link", $link );
+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 relational link for the site index.
+ * Display next post link that is adjacent to the current post.
*
- * @since 2.8.0
+ * @since 1.5.0
+ * @see get_next_post_link()
+ *
+ * @param string $format Optional. Link anchor format.
+ * @param string $link Optional. Link permalink format.
+ * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
+ * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
*/
-function index_rel_link() {
- echo get_index_rel_link();
+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 );
}
/**
- * Get parent post relational link.
+ * Get adjacent post link.
*
- * @since 2.8.0
+ * Can be either next post link or previous.
+ *
+ * @since 3.7.0
*
- * @param string $title Optional. Link title format.
+ * @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 get_parent_post_rel_link($title = '%title') {
- if ( ! empty( $GLOBALS['post'] ) && ! empty( $GLOBALS['post']->post_parent ) )
- $post = & get_post($GLOBALS['post']->post_parent);
+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_term, $excluded_terms, $previous, $taxonomy );
- if ( empty($post) )
- return;
+ if ( ! $post ) {
+ $output = '';
+ } else {
+ $title = $post->post_title;
- $date = mysql2date(get_option('date_format'), $post->post_date);
+ if ( empty( $post->post_title ) )
+ $title = $previous ? __( 'Previous Post' ) : __( 'Next Post' );
- $title = str_replace('%title', $post->post_title, $title);
- $title = str_replace('%date', $date, $title);
- $title = apply_filters('the_title', $title, $post->ID);
+ /** This filter is documented in wp-includes/post-template.php */
+ $title = apply_filters( 'the_title', $title, $post->ID );
- $link = "<link rel='up' title='";
- $link .= esc_attr( $title );
- $link .= "' href='" . get_permalink($post) . "' />\n";
+ $date = mysql2date( get_option( 'date_format' ), $post->post_date );
+ $rel = $previous ? 'prev' : 'next';
- return apply_filters( "parent_post_rel_link", $link );
-}
+ $string = '<a href="' . get_permalink( $post ) . '" rel="'.$rel.'">';
+ $inlink = str_replace( '%title', $title, $link );
+ $inlink = str_replace( '%date', $date, $inlink );
+ $inlink = $string . $inlink . '</a>';
-/**
- * Display relational link for parent item
- *
- * @since 2.8.0
- */
-function parent_post_rel_link($title = '%title') {
- echo get_parent_post_rel_link($title);
-}
+ $output = str_replace( '%link', $inlink, $format );
+ }
-/**
- * Display previous post link that is adjacent to the current post.
- *
- * @since 1.5.0
- *
- * @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 same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- */
-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);
-}
+ $adjacent = $previous ? 'previous' : 'next';
-/**
- * Display next post link that is adjacent to the current post.
- *
- * @since 1.5.0
- *
- * @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 same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- */
-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);
+ /**
+ * 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 );
}
/**
* Can be either next post link or previous.
*
* @since 2.5.0
- *
- * @param string $format Link anchor format.
- * @param string $link Link permalink format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- * @param bool $previous Optional, default is true. Whether display link to previous post.
+ * @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_cat = false, $excluded_categories = '', $previous = true) {
- if ( $previous && is_attachment() )
- $post = & get_post($GLOBALS['post']->post_parent);
- else
- $post = get_adjacent_post($in_same_cat, $excluded_categories, $previous);
-
- if ( !$post )
- return;
-
- $title = $post->post_title;
-
- if ( empty($post->post_title) )
- $title = $previous ? __('Previous Post') : __('Next Post');
-
- $title = apply_filters('the_title', $title, $post->ID);
- $date = mysql2date(get_option('date_format'), $post->post_date);
- $rel = $previous ? 'prev' : 'next';
-
- $string = '<a href="'.get_permalink($post).'" rel="'.$rel.'">';
- $link = str_replace('%title', $title, $link);
- $link = str_replace('%date', $date, $link);
- $link = $string . $link . '</a>';
-
- $format = str_replace('%link', $link, $format);
-
- $adjacent = $previous ? 'previous' : 'next';
- echo apply_filters( "{$adjacent}_post_link", $format, $link );
+function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
+ echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy );
}
/**
- * Retrieve get links for page numbers.
+ * Retrieve links for page numbers.
*
* @since 1.5.0
*
* @param int $pagenum Optional. Page ID.
+ * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
+* Otherwise, prepares the URL with esc_url_raw().
* @return string
*/
-function get_pagenum_link($pagenum = 1) {
+function get_pagenum_link($pagenum = 1, $escape = true ) {
global $wp_rewrite;
$pagenum = (int) $pagenum;
$home_root = parse_url(home_url());
$home_root = ( isset($home_root['path']) ) ? $home_root['path'] : '';
- $home_root = preg_quote( trailingslashit( $home_root ), '|' );
+ $home_root = preg_quote( $home_root, '|' );
- $request = preg_replace('|^'. $home_root . '|', '', $request);
+ $request = preg_replace('|^'. $home_root . '|i', '', $request);
$request = preg_replace('|^/+|', '', $request);
if ( !$wp_rewrite->using_permalinks() || is_admin() ) {
}
$request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request);
- $request = preg_replace( '|^index\.php|', '', $request);
+ $request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request);
$request = ltrim($request, '/');
$base = trailingslashit( get_bloginfo( 'url' ) );
if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' != $request ) )
- $base .= 'index.php/';
+ $base .= $wp_rewrite->index . '/';
if ( $pagenum > 1 ) {
$request = ( ( !empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . "/" . $pagenum, 'paged' );
$result = $base . $request . $query_string;
}
- $result = apply_filters('get_pagenum_link', $result);
-
- return $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 );
+ else
+ return esc_url_raw( $result );
}
/**
- * Retrieve next posts pages link.
+ * Retrieve next posts page link.
*
* Backported from 2.1.3 to 2.0.10.
*
}
/**
- * Display or return the next posts pages link.
+ * Display or return the next posts page link.
*
* @since 0.71
*
}
/**
- * Return the next posts pages link.
+ * Return the next posts page link.
*
* @since 2.7.0
*
* @param int $max_page Optional. Max pages.
* @return string|null
*/
-function get_next_posts_link( $label = 'Next Page »', $max_page = 0 ) {
+function get_next_posts_link( $label = null, $max_page = 0 ) {
global $paged, $wp_query;
if ( !$max_page )
$nextpage = intval($paged) + 1;
+ if ( null === $label )
+ $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 '<a href="' . next_posts( $max_page, false ) . "\" $attr>" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) . '</a>';
}
}
/**
- * Display the next posts pages link.
+ * Display the next posts page link.
*
* @since 0.71
* @uses get_next_posts_link()
* @param string $label Content for link text.
* @param int $max_page Optional. Max pages.
*/
-function next_posts_link( $label = 'Next Page »', $max_page = 0 ) {
+function next_posts_link( $label = null, $max_page = 0 ) {
echo get_next_posts_link( $label, $max_page );
}
/**
- * Retrieve previous post pages link.
+ * Retrieve previous posts page link.
*
* Will only return string, if not on a single page or post.
*
}
/**
- * Display or return the previous posts pages link.
+ * Display or return the previous posts page link.
*
* @since 0.71
*
}
/**
- * Return the previous posts pages link.
+ * Return the previous posts page link.
*
* @since 2.7.0
*
* @param string $label Optional. Previous page link text.
* @return string|null
*/
-function get_previous_posts_link( $label = '« Previous Page' ) {
+function get_previous_posts_link( $label = null ) {
global $paged;
+ if ( null === $label )
+ $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 '<a href="' . previous_posts( false ) . "\" $attr>". preg_replace( '/&([^#])(?![a-z]{1,8};)/', '&$1', $label ) .'</a>';
+ return '<a href="' . previous_posts( false ) . "\" $attr>". preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) .'</a>';
}
}
*
* @param string $label Optional. Previous page link text.
*/
-function previous_posts_link( $label = '« Previous Page' ) {
+function previous_posts_link( $label = null ) {
echo get_previous_posts_link( $label );
}
/**
* 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.
}
/**
- * Retrieve page numbers links.
+ * Retrieve comments page number link.
*
* @since 2.7.0
*
* @return string
*/
function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
- global $post, $wp_rewrite;
+ global $wp_rewrite;
$pagenum = (int) $pagenum;
- $result = get_permalink( $post->ID );
+ $result = get_permalink();
if ( 'newest' == get_option('default_comments_page') ) {
if ( $pagenum != $max_page ) {
$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;
}
/**
- * Return the link to next comments pages.
+ * Return the link to next comments page.
*
* @since 2.7.1
*
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 '<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>';
}
/**
- * Display the link to next comments pages.
+ * Display the link to next comments page.
*
* @since 2.7.0
*
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 '<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>';
}
* @see paginate_links()
* @since 2.7.0
*
- * @param string|array $args Optional args. See paginate_links.
+ * @param string|array $args Optional args. See paginate_links().
* @return string Markup for pagination links.
*/
function paginate_comments_links($args = array()) {
}
/**
- * Retrieve shortcut link.
+ * Retrieve the Press This bookmarklet link.
*
* Use this in 'a' element 'href' attribute.
*
* @return string
*/
function get_shortcut_link() {
+ // In case of breaking changes, version this. #WP20071
$link = "javascript:
var d=document,
w=window,
$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 );
}
/**
* Retrieve the home url for the current site.
*
- * Returns the 'home' option with the appropriate protocol, 'https' if
+ * Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
* @uses get_home_url()
*
* @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
+ * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @return string Home url link with optional path appended.
*/
function home_url( $path = '', $scheme = null ) {
- return get_home_url(null, $path, $scheme);
+ return get_home_url( null, $path, $scheme );
}
/**
* Retrieve the home url for a given site.
*
- * Returns the 'home' option with the appropriate protocol, 'https' if
+ * Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
+ * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @return string Home url link with optional path appended.
*/
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
$orig_scheme = $scheme;
- if ( !in_array( $scheme, array( 'http', 'https' ) ) )
- $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
-
- if ( empty( $blog_id ) || !is_multisite() )
+ if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'home' );
- else
- $url = get_blog_option( $blog_id, 'home' );
+ } else {
+ switch_to_blog( $blog_id );
+ $url = get_option( 'home' );
+ restore_current_blog();
+ }
- if ( 'http' != $scheme )
- $url = str_replace( 'http://', "$scheme://", $url );
+ if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
+ if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] )
+ $scheme = 'https';
+ else
+ $scheme = parse_url( $url, PHP_URL_SCHEME );
+ }
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ $url = set_url_scheme( $url, $scheme );
+
+ 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 );
}
/**
* Retrieve the site url for the current site.
*
- * Returns the 'site_url' option with the appropriate protocol, 'https' if
+ * Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
- * @since 2.6.0
+ * @since 3.0.0
*
* @uses get_site_url()
*
* @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
+ * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
*/
function site_url( $path = '', $scheme = null ) {
- return get_site_url(null, $path, $scheme);
+ return get_site_url( null, $path, $scheme );
}
/**
* Retrieve the site url for a given site.
*
- * Returns the 'site_url' option with the appropriate protocol, 'https' if
+ * Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
+ * @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
* @return string Site url link with optional path appended.
*/
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
- // should the list of allowed schemes be maintained elsewhere?
- $orig_scheme = $scheme;
- if ( !in_array( $scheme, array( 'http', 'https' ) ) ) {
- 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 ( empty( $blog_id ) || !is_multisite() )
+ if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'siteurl' );
- else
- $url = get_blog_option( $blog_id, 'siteurl' );
+ } else {
+ switch_to_blog( $blog_id );
+ $url = get_option( 'siteurl' );
+ restore_current_blog();
+ }
- if ( 'http' != $scheme )
- $url = str_replace( 'http://', "{$scheme}://", $url );
+ $url = set_url_scheme( $url, $scheme );
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ if ( $path && is_string( $path ) )
$url .= '/' . ltrim( $path, '/' );
- return apply_filters( 'site_url', $url, $path, $orig_scheme, $blog_id );
+ /**
+ * 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
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function admin_url( $path = '', $scheme = 'admin' ) {
- return get_admin_url(null, $path, $scheme);
+ return get_admin_url( null, $path, $scheme );
}
/**
* 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.
- * @param string $path Optional path relative to the admin url
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
$url = get_site_url($blog_id, 'wp-admin/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
- $url .= ltrim($path, '/');
+ if ( $path && is_string( $path ) )
+ $url .= ltrim( $path, '/' );
- return apply_filters('admin_url', $url, $path, $blog_id);
+ /**
+ * 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.
+ * @param string $scheme Optional. Scheme to give the includes url context.
* @return string Includes url link with optional path appended.
*/
-function includes_url($path = '') {
- $url = site_url() . '/' . WPINC . '/';
+function includes_url( $path = '', $scheme = null ) {
+ $url = site_url( '/' . WPINC . '/', $scheme );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ 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.
* @return string Content url link with optional path appended.
*/
function content_url($path = '') {
- $url = WP_CONTENT_URL;
- if ( 0 === strpos($url, 'http') && is_ssl() )
- $url = str_replace( 'http://', 'https://', $url );
+ $url = set_url_scheme( WP_CONTENT_URL );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ 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;
else
$url = WP_PLUGIN_URL;
- if ( 0 === strpos($url, 'http') && is_ssl() )
- $url = str_replace( 'http://', 'https://', $url );
+
+ $url = set_url_scheme( $url );
if ( !empty($plugin) && is_string($plugin) ) {
$folder = dirname(plugin_basename($plugin));
$url .= '/' . ltrim($folder, '/');
}
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ 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 );
}
/**
* Retrieve the site url for the current network.
*
- * Returns the site url with the appropriate protocol, 'https' if
+ * Returns the site url with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
* @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
+ * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
*/
function network_site_url( $path = '', $scheme = null ) {
- global $current_site;
-
- if ( !is_multisite() )
+ if ( ! is_multisite() )
return site_url($path, $scheme);
- $orig_scheme = $scheme;
- if ( !in_array($scheme, array('http', 'https')) ) {
- 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' );
- }
+ $current_site = get_current_site();
- $url = $scheme . '://' . $current_site->domain . $current_site->path;
+ if ( 'relative' == $scheme )
+ $url = $current_site->path;
+ else
+ $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
- $url .= ltrim($path, '/');
+ if ( $path && is_string( $path ) )
+ $url .= ltrim( $path, '/' );
- return apply_filters('network_site_url', $url, $path, $orig_scheme);
+ /**
+ * 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 );
}
/**
* Retrieve the home url for the current network.
*
- * Returns the home url with the appropriate protocol, 'https' if
+ * Returns the home url with the appropriate protocol, 'https' if
* 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.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
+ * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @return string Home url link with optional path appended.
*/
function network_home_url( $path = '', $scheme = null ) {
- global $current_site;
-
- if ( !is_multisite() )
+ if ( ! is_multisite() )
return home_url($path, $scheme);
+ $current_site = get_current_site();
$orig_scheme = $scheme;
- if ( !in_array($scheme, array('http', 'https')) )
- $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
+ if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) )
+ $scheme = is_ssl() && ! is_admin() ? 'https' : 'http';
- $url = $scheme . '://' . $current_site->domain . $current_site->path;
+ if ( 'relative' == $scheme )
+ $url = $current_site->path;
+ else
+ $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ 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
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function network_admin_url( $path = '', $scheme = 'admin' ) {
if ( ! is_multisite() )
$url = network_site_url('wp-admin/network/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ 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
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/user/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ 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
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function self_admin_url($path = '', $scheme = 'admin') {
if ( is_network_admin() )
return admin_url($path, $scheme);
}
+/**
+ * Set the scheme for a URL
+ *
+ * @since 3.4.0
+ *
+ * @param string $url Absolute url that includes a scheme
+ * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
+ * @return string $url URL with chosen scheme.
+ */
+function set_url_scheme( $url, $scheme = null ) {
+ $orig_scheme = $scheme;
+
+ if ( ! $scheme ) {
+ $scheme = is_ssl() ? 'https' : 'http';
+ } elseif ( $scheme === 'admin' || $scheme === 'login' || $scheme === 'login_post' || $scheme === 'rpc' ) {
+ $scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http';
+ } elseif ( $scheme !== 'http' && $scheme !== 'https' && $scheme !== 'relative' ) {
+ $scheme = is_ssl() ? 'https' : 'http';
+ }
+
+ $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 );
+}
+
/**
* Get the URL to the user's dashboard.
*
- * If a user does not belong to any sites, the global user dashboard is used. If the user belongs to the current site,
- * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
+ * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
+ * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
* primary blog is returned.
*
* @since 3.1.0
*
- * @param int $user_id User ID
- * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
+ * @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
+ * @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 ( empty($blogs) ) {
+ if ( ! is_super_admin() && empty($blogs) ) {
$url = user_admin_url( $path, $scheme );
} elseif ( ! is_multisite() ) {
$url = admin_url( $path, $scheme );
} else {
$current_blog = get_current_blog_id();
- if ( $current_blog && in_array($current_blog, array_keys($blogs)) ) {
+ if ( $current_blog && ( is_super_admin( $user_id ) || in_array( $current_blog, array_keys( $blogs ) ) ) ) {
$url = admin_url( $path, $scheme );
} else {
$active = get_active_blog_for_user( $user_id );
}
}
+ /**
+ * 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);
}
*
* @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.
- * @return string Dashboard url link with optional path appended
+ * @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
+ * Output rel=canonical for singular queries.
*
- * @package WordPress
* @since 2.9.0
*/
function rel_canonical() {
return;
$link = get_permalink( $id );
+
+ if ( $page = get_query_var('cpage') )
+ $link = get_comments_pagenum_link( $page );
+
echo "<link rel='canonical' href='$link' />\n";
}
/**
* Return a shortlink for a post, page, attachment, or blog.
*
- * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
- * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
- * Plugins can short circuit this function via the pre_get_shortlink filter or filter the output
+ * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
+ * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
+ * Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output
* via the get_shortlink filter.
*
* @since 3.0.0.
*
- * @param int $id A post or blog id. Default is 0, which means the current post or blog.
+ * @param int $id A post or blog id. Default is 0, which means the current post or blog.
* @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
* @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
* @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
*/
function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
- // 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 );
}
/**
- * Inject rel=sortlink into head if a shortlink is defined for the current page.
+ * Inject rel=shortlink into head if a shortlink is defined for the current page.
*
* Attached to the wp_head action.
*
*
* @since 3.0.0
*
- * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
- * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
+ * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
+ * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $before Optional HTML to display before the link.
- * @param string $before Optional HTML to display after the link.
+ * @param string $after Optional HTML to display after the link.
*/
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
- global $post;
+ $post = get_post();
if ( empty( $text ) )
$text = __('This is the short link.');
if ( empty( $title ) )
- $title = the_title_attribute( array( 'echo' => FALSE ) );
+ $title = the_title_attribute( array( 'echo' => false ) );
$shortlink = wp_get_shortlink( $post->ID );
if ( !empty( $shortlink ) ) {
$link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>';
+
+ /**
+ * 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;
}
}
-
-?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff