X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/699231ae09f7057a4d0000cdf32e50a3df6a04ca..bf5c68485ef07868ad0a91168ecd0092af7661ae:/wp-includes/link-template.php
diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php
index 0b92174d..7c5f5119 100644
--- a/wp-includes/link-template.php
+++ b/wp-includes/link-template.php
@@ -27,8 +27,8 @@ function the_permalink() {
* @since 2.2.0
* @uses $wp_rewrite
*
- * @param $string String a URL with or without a trailing slash.
- * @param $type_of_url String the type of URL being considered (e.g. single, category, etc) for use in the filter.
+ * @param string $string URL with or without a trailing slash.
+ * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
* @return string
*/
function user_trailingslashit($string, $type_of_url = '') {
@@ -39,7 +39,7 @@ function user_trailingslashit($string, $type_of_url = '') {
$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
+ // 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;
}
@@ -108,7 +108,7 @@ function get_permalink($id = 0, $leavename = false) {
elseif ( $post->post_type == 'attachment' )
return get_attachment_link($post->ID);
elseif ( in_array($post->post_type, get_post_types( array('_builtin' => false) ) ) )
- return get_post_permalink($post, $leavename, $sample);
+ return get_post_permalink($post->ID, $leavename, $sample);
$permalink = get_option('permalink_structure');
@@ -185,11 +185,11 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
$slug = $post->post_name;
- $draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
+ $draft_or_pending = isset($post->post_status) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
$post_type = get_post_type_object($post->post_type);
- if ( !empty($post_link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) {
+ if ( !empty($post_link) && ( !$draft_or_pending || $sample ) ) {
if ( ! $leavename ) {
if ( $post_type->hierarchical )
$slug = get_page_uri($id);
@@ -204,7 +204,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
$post_link = home_url($post_link);
}
- return apply_filters('post_type_link', $post_link, $id, $leavename, $sample);
+ return apply_filters('post_type_link', $post_link, $post, $leavename, $sample);
}
/**
@@ -271,11 +271,15 @@ function _get_page_link( $id = false, $leavename = false, $sample = false ) {
else
$post = &get_post($id);
+ $draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
+
$link = $wp_rewrite->get_page_permastruct();
- if ( '' != $link && ( ( isset($post->post_status) && 'draft' != $post->post_status && 'pending' != $post->post_status ) || $sample ) ) {
- if ( ! $leavename )
+ if ( !empty($link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) {
+ if ( ! $leavename ) {
$link = str_replace('%pagename%', get_page_uri($id), $link);
+ }
+
$link = home_url($link);
$link = user_trailingslashit($link, 'page');
} else {
@@ -461,13 +465,13 @@ function get_feed_link($feed = '') {
* @param string $feed Optional. Feed type.
* @return string
*/
-function get_post_comments_feed_link($post_id = '', $feed = '') {
- global $id;
+function get_post_comments_feed_link($post_id = 0, $feed = '') {
+ $post_id = absint( $post_id );
- if ( empty($post_id) )
- $post_id = (int) $id;
+ if ( ! $post_id )
+ $post_id = get_the_ID();
- if ( empty($feed) )
+ if ( empty( $feed ) )
$feed = get_default_feed();
if ( '' != get_option('permalink_structure') ) {
@@ -556,7 +560,7 @@ function get_author_feed_link( $author_id, $feed = '' ) {
/**
* 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
@@ -572,9 +576,9 @@ function get_category_feed_link($cat_id, $feed = '') {
}
/**
- * 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
@@ -582,7 +586,7 @@ function get_category_feed_link($cat_id, $feed = '') {
* @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;
@@ -649,18 +653,11 @@ function get_tag_feed_link($tag_id, $feed = '') {
* @since 2.7.0
*
* @param int $tag_id Tag ID
+ * @param string $taxonomy Taxonomy
* @return string
*/
-function get_edit_tag_link( $tag_id = 0, $taxonomy = 'post_tag' ) {
- global $post_type;
- $tax = get_taxonomy($taxonomy);
- if ( !current_user_can($tax->cap->edit_terms) )
- return;
-
- $tag = get_term($tag_id, $taxonomy);
-
- $location = admin_url('edit-tags.php?action=edit&taxonomy=' . $taxonomy . '&' . (!empty($post_type) ? 'post_type=' . $post_type .'&' : '') .'tag_ID=' . $tag->term_id);
- return apply_filters( 'get_edit_tag_link', $location );
+function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
+ return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
}
/**
@@ -672,20 +669,74 @@ function get_edit_tag_link( $tag_id = 0, $taxonomy = 'post_tag' ) {
* @param string $before Optional. Display before edit link.
* @param string $after Optional. Display after edit link.
* @param int|object $tag Tag object or ID
- * @return string|null HTML content, if $echo is set to false.
+ * @return string HTML content.
*/
function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
- $tax = get_taxonomy('post_tag');
- if ( !current_user_can($tax->cap->edit_terms) )
+ $link = edit_term_link( $link, '', '', false, $tag );
+ echo $before . apply_filters( 'edit_tag_link', $link ) . $after;
+}
+
+/**
+ * Retrieve edit term url.
+ *
+ * @since 3.1.0
+ *
+ * @param int $term_id Term ID
+ * @param string $taxonomy Taxonomy
+ * @param string $object_type The object type
+ * @return string
+ */
+function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
+ $tax = get_taxonomy( $taxonomy );
+ if ( !current_user_can( $tax->cap->edit_terms ) )
return;
- $tag = get_term($tag, 'post_tag');
+ $term = get_term( $term_id, $taxonomy );
- if ( empty($link) )
+ $args = array(
+ 'action' => 'edit',
+ 'taxonomy' => $taxonomy,
+ 'tag_ID' => $term->term_id,
+ );
+
+ if ( $object_type )
+ $args['post_type'] = $object_type;
+
+ $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
+
+ return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type );
+}
+
+/**
+ * Display or retrieve edit term link with formatting.
+ *
+ * @since 3.1.0
+ *
+ * @param string $link Optional. Anchor text.
+ * @param string $before Optional. Display before edit link.
+ * @param string $after Optional. Display after edit link.
+ * @param object $term Term object
+ * @return string HTML content.
+ */
+function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
+ if ( is_null( $term ) ) {
+ $term = get_queried_object();
+ }
+
+ $tax = get_taxonomy( $term->taxonomy );
+ if ( !current_user_can($tax->cap->edit_terms) )
+ return;
+
+ if ( empty( $link ) )
$link = __('Edit This');
- $link = '' . $link . '';
- echo $before . apply_filters( 'edit_tag_link', $link, $tag->term_id ) . $after;
+ $link = '' . $link . '';
+ $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after;
+
+ if ( $echo )
+ echo $link;
+ else
+ return $link;
}
/**
@@ -776,6 +827,65 @@ function get_search_comments_feed_link($search_query = '', $feed = '') {
return $link;
}
+/**
+ * Retrieve the permalink for a post type archive.
+ *
+ * @since 3.1.0
+ *
+ * @param string $post_type Post type
+ * @return string
+ */
+function get_post_type_archive_link( $post_type ) {
+ global $wp_rewrite;
+ if ( ! $post_type_obj = get_post_type_object( $post_type ) )
+ return false;
+
+ if ( ! $post_type_obj->has_archive )
+ return false;
+
+ if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) {
+ $struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive;
+ if ( $post_type_obj->rewrite['with_front'] )
+ $struct = $wp_rewrite->front . $struct;
+ else
+ $struct = $wp_rewrite->root . $struct;
+ $link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) );
+ } else {
+ $link = home_url( '?post_type=' . $post_type );
+ }
+
+ return apply_filters( 'post_type_archive_link', $link, $post_type );
+}
+
+/**
+ * Retrieve the permalink for a post type archive feed.
+ *
+ * @since 3.1.0
+ *
+ * @param string $post_type Post type
+ * @param string $feed Optional. Feed type
+ * @return string
+ */
+function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
+ $default_feed = get_default_feed();
+ if ( empty( $feed ) )
+ $feed = $default_feed;
+
+ 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);
+ $link .= 'feed/';
+ if ( $feed != $default_feed )
+ $link .= "$feed/";
+ } else {
+ $link = add_query_arg( 'feed', $feed, $link );
+ }
+
+ return apply_filters( 'post_type_archive_feed_link', $link, $feed );
+}
+
/**
* Retrieve edit posts link for post.
*
@@ -785,7 +895,7 @@ function get_search_comments_feed_link($search_query = '', $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' ) {
@@ -846,7 +956,7 @@ function edit_post_link( $link = null, $before = '', $after = '', $id = 0 ) {
*/
function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
if ( ! empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '3.0.0' );
+ _deprecated_argument( __FUNCTION__, '3.0' );
if ( !$post = &get_post( $id ) )
return;
@@ -875,15 +985,9 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false
*/
function get_edit_comment_link( $comment_id = 0 ) {
$comment = &get_comment( $comment_id );
- $post = &get_post( $comment->comment_post_ID );
- if ( $post->post_type == 'page' ) {
- if ( !current_user_can( 'edit_page', $post->ID ) )
- return;
- } else {
- if ( !current_user_can( 'edit_post', $post->ID ) )
- return;
- }
+ if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
+ return;
$location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID;
return apply_filters( 'get_edit_comment_link', $location );
@@ -900,20 +1004,15 @@ function get_edit_comment_link( $comment_id = 0 ) {
* @return string|null HTML content, if $echo is set to false.
*/
function edit_comment_link( $link = null, $before = '', $after = '' ) {
- global $comment, $post;
+ global $comment;
- if ( $post->post_type == 'page' ) {
- if ( !current_user_can( 'edit_page', $post->ID ) )
- return;
- } else {
- if ( !current_user_can( 'edit_post', $post->ID ) )
- return;
- }
+ if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
+ return;
if ( null === $link )
$link = __('Edit This');
- $link = '';
+ $link = '';
echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after;
}
@@ -954,51 +1053,51 @@ function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark =
if ( empty($link) )
$link = __('Edit This');
- $link = '' . $link . '';
+ $link = '' . $link . '';
echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after;
}
// Navigation links
/**
- * Retrieve previous post link that is adjacent to current post.
+ * Retrieve previous post that is adjacent to current post.
*
* @since 1.5.0
*
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- * @return string
+ * @param bool $in_same_cat Optional. Whether post should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
function get_previous_post($in_same_cat = false, $excluded_categories = '') {
return get_adjacent_post($in_same_cat, $excluded_categories);
}
/**
- * Retrieve next post link that is adjacent to current post.
+ * Retrieve next post that is adjacent to current post.
*
* @since 1.5.0
*
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
- * @return string
+ * @param bool $in_same_cat Optional. Whether post should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
function get_next_post($in_same_cat = false, $excluded_categories = '') {
return get_adjacent_post($in_same_cat, $excluded_categories, false);
}
/**
- * Retrieve adjacent post link.
+ * Retrieve adjacent post.
*
- * Can either be next or previous post link.
+ * Can either be next or previous post.
*
* @since 2.5.0
*
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
+ * @param bool $in_same_cat Optional. Whether post should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @param bool $previous Optional. Whether to retrieve previous post.
- * @return string
+ * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
-function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $previous = true) {
+function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $previous = true ) {
global $post, $wpdb;
if ( empty( $post ) )
@@ -1008,7 +1107,7 @@ function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $pre
$join = '';
$posts_in_ex_cats_sql = '';
- if ( $in_same_cat || !empty($excluded_categories) ) {
+ if ( $in_same_cat || ! empty( $excluded_categories ) ) {
$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";
if ( $in_same_cat ) {
@@ -1017,9 +1116,20 @@ function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $pre
}
$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) ) {
+ if ( ! empty( $excluded_categories ) ) {
+ if ( ! is_array( $excluded_categories ) ) {
+ // back-compat, $excluded_categories used to be IDs separated by " and "
+ if ( strpos( $excluded_categories, ' and ' ) !== false ) {
+ _deprecated_argument( __FUNCTION__, '3.3', sprintf( __( 'Use commas instead of %s to separate excluded categories.' ), "'and'" ) );
+ $excluded_categories = explode( ' and ', $excluded_categories );
+ } else {
+ $excluded_categories = explode( ',', $excluded_categories );
+ }
+ }
+
+ $excluded_categories = array_map( 'intval', $excluded_categories );
+
+ if ( ! empty( $cat_array ) ) {
$excluded_categories = array_diff($excluded_categories, $cat_array);
$posts_in_ex_cats_sql = '';
}
@@ -1060,9 +1170,9 @@ function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $pre
* @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 bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
+ * @param bool $previous Optional, default is true. Whether to display link to previous or next post.
* @return string
*/
function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $previous = true) {
@@ -1097,8 +1207,8 @@ function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $ex
* @since 2.8.0
*
* @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
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);
@@ -1108,7 +1218,7 @@ function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $exclu
/**
* 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
*
*/
@@ -1124,8 +1234,8 @@ function adjacent_posts_rel_link_wp_head() {
* @since 2.8.0
*
* @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
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);
@@ -1137,8 +1247,8 @@ function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_c
* @since 2.8.0
*
* @param string $title Optional. Link title format.
- * @param bool $in_same_cat Optional. Whether link should be in same category.
- * @param string $excluded_categories Optional. Excluded categories IDs.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
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);
@@ -1147,157 +1257,46 @@ function prev_post_rel_link($title = '%title', $in_same_cat = false, $excluded_c
/**
* Retrieve boundary post.
*
- * Boundary being either the first or last post by publish date within the contraitns specified
- * by in same category or excluded categories.
+ * Boundary being either the first or last post by publish date within the constraints specified
+ * by $in_same_cat or $excluded_categories.
*
* @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 $previous Optional. Whether to retrieve first post.
+ * @param bool $in_same_cat Optional. Whether returned post should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
+ * @param bool $start Optional. Whether to retrieve first or last post.
* @return object
*/
-function get_boundary_post($in_same_cat = false, $excluded_categories = '', $start = true) {
+function get_boundary_post( $in_same_cat = false, $excluded_categories = '', $start = true ) {
global $post;
- if ( empty($post) || !is_single() || is_attachment() )
+ if ( empty($post) || ! is_single() || is_attachment() )
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( ! is_array( $excluded_categories ) )
+ $excluded_categories = explode( ',', $excluded_categories );
- if ( !empty($excluded_categories) ) {
- $excluded_categories = array_map('intval', explode(',', $excluded_categories));
+ if ( $in_same_cat || ! empty( $excluded_categories ) ) {
+ if ( $in_same_cat )
+ $cat_array = wp_get_object_terms( $post->ID, 'category', array( 'fields' => 'ids' ) );
- if ( !empty($cat_array) )
- $excluded_categories = array_diff($excluded_categories, $cat_array);
+ if ( ! empty( $excluded_categories ) ) {
+ $excluded_categories = array_map( 'intval', $excluded_categories );
+ $excluded_categories = array_diff( $excluded_categories, $cat_array );
$inverse_cats = array();
- foreach ( $excluded_categories as $excluded_category)
+ foreach ( $excluded_categories as $excluded_category )
$inverse_cats[] = $excluded_category * -1;
$excluded_categories = $inverse_cats;
}
}
- $categories = implode(',', array_merge($cat_array, $excluded_categories) );
+ $categories = implode( ',', array_merge( $cat_array, $excluded_categories ) );
$order = $start ? 'ASC' : 'DESC';
- return get_posts( array('numberposts' => 1, 'no_found_rows' => true, 'order' => $order, 'orderby' => 'ID', 'category' => $categories) );
-}
-
-/**
- * Get boundary post relational link.
- *
- * Can either be start or end post relational 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 bool $start Optional, default is true. Whether display link to first post.
- * @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 ? "\n";
-
- $boundary = $start ? 'start' : 'end';
- return apply_filters( "{$boundary}_post_rel_link", $link );
-}
-
-/**
- * Display relational link for the first post.
- *
- * @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.
- */
-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);
-}
-
-/**
- * Get site index relational link.
- *
- * @since 2.8.0
- *
- * @return string
- */
-function get_index_rel_link() {
- $link = "\n";
- return apply_filters( "index_rel_link", $link );
-}
-
-/**
- * Display relational link for the site index.
- *
- * @since 2.8.0
- */
-function index_rel_link() {
- echo get_index_rel_link();
-}
-
-/**
- * Get parent post relational link.
- *
- * @since 2.8.0
- *
- * @param string $title Optional. Link title format.
- * @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);
-
- if ( empty($post) )
- return;
-
- $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 = "\n";
-
- return apply_filters( "parent_post_rel_link", $link );
-}
-
-/**
- * Display relational link for parent item
- *
- * @since 2.8.0
- */
-function parent_post_rel_link($title = '%title') {
- echo get_parent_post_rel_link($title);
+ return get_posts( array('numberposts' => 1, 'category' => $categories, 'order' => $order, 'update_post_term_cache' => false, 'update_post_meta_cache' => false) );
}
/**
@@ -1307,8 +1306,8 @@ function parent_post_rel_link($title = '%title') {
*
* @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.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
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);
@@ -1321,8 +1320,8 @@ function previous_post_link($format='« %link', $link='%title', $in_same_ca
*
* @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.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
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);
@@ -1337,9 +1336,9 @@ function next_post_link($format='%link »', $link='%title', $in_same_cat =
*
* @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.
+ * @param bool $in_same_cat Optional. Whether link should be in a same category.
+ * @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
+ * @param bool $previous Optional, default is true. Whether to display link to previous or next post.
*/
function adjacent_post_link($format, $link, $in_same_cat = false, $excluded_categories = '', $previous = true) {
if ( $previous && is_attachment() )
@@ -1371,7 +1370,7 @@ function adjacent_post_link($format, $link, $in_same_cat = false, $excluded_cate
}
/**
- * Retrieve get links for page numbers.
+ * Retrieve links for page numbers.
*
* @since 1.5.0
*
@@ -1411,7 +1410,7 @@ function get_pagenum_link($pagenum = 1) {
$query_string = '';
}
- $request = preg_replace( '|page/\d+/?$|', '', $request);
+ $request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request);
$request = preg_replace( '|^index\.php|', '', $request);
$request = ltrim($request, '/');
@@ -1421,7 +1420,7 @@ function get_pagenum_link($pagenum = 1) {
$base .= 'index.php/';
if ( $pagenum > 1 ) {
- $request = ( ( !empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( 'page/' . $pagenum, 'paged' );
+ $request = ( ( !empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . "/" . $pagenum, 'paged' );
}
$result = $base . $request . $query_string;
@@ -1433,7 +1432,7 @@ function get_pagenum_link($pagenum = 1) {
}
/**
- * Retrieve next posts pages link.
+ * Retrieve next posts page link.
*
* Backported from 2.1.3 to 2.0.10.
*
@@ -1455,7 +1454,7 @@ function get_next_posts_page_link($max_page = 0) {
}
/**
- * Display or return the next posts pages link.
+ * Display or return the next posts page link.
*
* @since 0.71
*
@@ -1472,7 +1471,7 @@ function next_posts( $max_page = 0, $echo = true ) {
}
/**
- * Return the next posts pages link.
+ * Return the next posts page link.
*
* @since 2.7.0
*
@@ -1480,7 +1479,7 @@ function next_posts( $max_page = 0, $echo = true ) {
* @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 )
@@ -1491,14 +1490,17 @@ function get_next_posts_link( $label = 'Next Page »', $max_page = 0 ) {
$nextpage = intval($paged) + 1;
- if ( !is_single() && ( empty($paged) || $nextpage <= $max_page) ) {
+ if ( null === $label )
+ $label = __( 'Next Page »' );
+
+ if ( !is_single() && ( $nextpage <= $max_page ) ) {
$attr = apply_filters( 'next_posts_link_attributes', '' );
return '" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) . '';
}
}
/**
- * Display the next posts pages link.
+ * Display the next posts page link.
*
* @since 0.71
* @uses get_next_posts_link()
@@ -1506,12 +1508,12 @@ function get_next_posts_link( $label = 'Next Page »', $max_page = 0 ) {
* @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.
*
@@ -1533,7 +1535,7 @@ function get_previous_posts_page_link() {
}
/**
- * Display or return the previous posts pages link.
+ * Display or return the previous posts page link.
*
* @since 0.71
*
@@ -1549,16 +1551,19 @@ function previous_posts( $echo = true ) {
}
/**
- * 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 ) {
$attr = apply_filters( 'previous_posts_link_attributes', '' );
return '". preg_replace( '/&([^#])(?![a-z]{1,8};)/', '&$1', $label ) .'';
@@ -1573,7 +1578,7 @@ function get_previous_posts_link( $label = '« Previous Page' ) {
*
* @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 );
}
@@ -1631,7 +1636,7 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
}
/**
- * Retrieve page numbers links.
+ * Retrieve comments page number link.
*
* @since 2.7.0
*
@@ -1667,7 +1672,7 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
}
/**
- * Return the link to next comments pages.
+ * Return the link to next comments page.
*
* @since 2.7.1
*
@@ -1701,7 +1706,7 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
}
/**
- * Display the link to next comments pages.
+ * Display the link to next comments page.
*
* @since 2.7.0
*
@@ -1754,7 +1759,7 @@ function previous_comments_link( $label = '' ) {
* @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()) {
@@ -1820,7 +1825,7 @@ function get_shortcut_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.
*
@@ -1830,7 +1835,7 @@ function get_shortcut_link() {
* @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'.
* @return string Home url link with optional path appended.
*/
function home_url( $path = '', $scheme = null ) {
@@ -1840,7 +1845,7 @@ function home_url( $path = '', $scheme = null ) {
/**
* 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.
*
@@ -1849,7 +1854,7 @@ function home_url( $path = '', $scheme = null ) {
*
* @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'.
* @return string Home url link with optional path appended.
*/
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
@@ -1859,11 +1864,12 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
$scheme = is_ssl() && !is_admin() ? 'https' : 'http';
if ( empty( $blog_id ) || !is_multisite() )
- $home = get_option( 'home' );
+ $url = get_option( 'home' );
else
- $home = get_blog_option( $blog_id, 'home' );
+ $url = get_blog_option( $blog_id, 'home' );
- $url = str_replace( 'http://', "$scheme://", $home );
+ if ( 'http' != $scheme )
+ $url = str_replace( 'http://', "$scheme://", $url );
if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
$url .= '/' . ltrim( $path, '/' );
@@ -1874,7 +1880,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
/**
* 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.
*
@@ -1884,7 +1890,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
* @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. Currently 'http', 'https', 'login', 'login_post', or 'admin'.
* @return string Site url link with optional path appended.
*/
function site_url( $path = '', $scheme = null ) {
@@ -1894,7 +1900,7 @@ function site_url( $path = '', $scheme = null ) {
/**
* 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.
*
@@ -1903,7 +1909,7 @@ function site_url( $path = '', $scheme = null ) {
*
* @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', or 'admin'.
* @return string Site url link with optional path appended.
*/
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
@@ -1925,7 +1931,8 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
else
$url = get_blog_option( $blog_id, 'siteurl' );
- $url = str_replace( 'http://', "{$scheme}://", $url );
+ if ( 'http' != $scheme )
+ $url = str_replace( 'http://', "{$scheme}://", $url );
if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
$url .= '/' . ltrim( $path, '/' );
@@ -1939,9 +1946,9 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
* @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);
@@ -1954,9 +1961,9 @@ function admin_url( $path = '', $scheme = 'admin' ) {
* @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);
@@ -2047,7 +2054,7 @@ function plugins_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.
*
@@ -2055,7 +2062,7 @@ function plugins_url($path = '', $plugin = '') {
* @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. Currently 'http', 'https', 'login', 'login_post', or 'admin'.
* @return string Site url link with optional path appended.
*/
function network_site_url( $path = '', $scheme = null ) {
@@ -2076,9 +2083,7 @@ function network_site_url( $path = '', $scheme = null ) {
$scheme = ( is_ssl() ? 'https' : 'http' );
}
- $url = 'http://' . $current_site->domain . $current_site->path;
-
- $url = str_replace( 'http://', "{$scheme}://", $url );
+ $url = $scheme . '://' . $current_site->domain . $current_site->path;
if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
$url .= ltrim($path, '/');
@@ -2089,7 +2094,7 @@ function network_site_url( $path = '', $scheme = null ) {
/**
* 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.
*
@@ -2097,7 +2102,7 @@ function network_site_url( $path = '', $scheme = null ) {
* @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'.
* @return string Home url link with optional path appended.
*/
function network_home_url( $path = '', $scheme = null ) {
@@ -2111,9 +2116,7 @@ function network_home_url( $path = '', $scheme = null ) {
if ( !in_array($scheme, array('http', 'https')) )
$scheme = is_ssl() && !is_admin() ? 'https' : 'http';
- $url = 'http://' . $current_site->domain . $current_site->path;
-
- $url = str_replace( 'http://', "$scheme://", $url );
+ $url = $scheme . '://' . $current_site->domain . $current_site->path;
if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
$url .= ltrim( $path, '/' );
@@ -2127,12 +2130,15 @@ function network_home_url( $path = '', $scheme = null ) {
* @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' ) {
- $url = network_site_url('wp-admin/', $scheme);
+ if ( ! is_multisite() )
+ return admin_url( $path, $scheme );
+
+ $url = network_site_url('wp-admin/network/', $scheme);
if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
$url .= ltrim($path, '/');
@@ -2141,7 +2147,105 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
}
/**
- * Output rel=canonical for singular queries
+ * 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 $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
+ * @return string Admin url link with optional path appended.
+*/
+function user_admin_url( $path = '', $scheme = 'admin' ) {
+ $url = network_site_url('wp-admin/user/', $scheme);
+
+ if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ $url .= ltrim($path, '/');
+
+ 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 $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
+ * @return string Admin url link with optional path appended.
+*/
+function self_admin_url($path = '', $scheme = 'admin') {
+ if ( is_network_admin() )
+ return network_admin_url($path, $scheme);
+ elseif ( is_user_admin() )
+ return user_admin_url($path, $scheme);
+ else
+ return admin_url($path, $scheme);
+}
+
+/**
+ * Get the URL to the user's dashboard.
+ *
+ * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
+ * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
+ * primary blog is returned.
+ *
+ * @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 string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
+ * @return string Dashboard url link with optional path appended.
+ */
+function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
+ $user_id = (int) $user_id;
+
+ $blogs = get_blogs_of_user( $user_id );
+ 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 && ( 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 );
+ if ( $active )
+ $url = get_admin_url( $active->blog_id, $path, $scheme );
+ else
+ $url = user_admin_url( $path, $scheme );
+ }
+ }
+
+ return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme);
+}
+
+/**
+ * Get the URL to the user's profile editor.
+ *
+ * @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.
+ */
+function get_edit_profile_url( $user, $scheme = 'admin' ) {
+ $user = (int) $user;
+
+ 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 );
+
+ return apply_filters( 'edit_profile_url', $url, $user, $scheme);
+}
+
+/**
+ * Output rel=canonical for singular queries.
*
* @package WordPress
* @since 2.9.0
@@ -2161,15 +2265,15 @@ function rel_canonical() {
/**
* 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 string $contex 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 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.
*/
@@ -2201,7 +2305,7 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
}
/**
- * 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.
*
@@ -2215,7 +2319,7 @@ function wp_shortlink_wp_head() {
if ( empty( $shortlink ) )
return;
- echo "\n";
+ echo "\n";
}
/**
@@ -2228,7 +2332,7 @@ function wp_shortlink_wp_head() {
* @uses wp_get_shortlink()
*/
function wp_shortlink_header() {
- if ( headers_sent() )
+ if ( headers_sent() )
return;
$shortlink = wp_get_shortlink(0, 'query');
@@ -2248,10 +2352,10 @@ function wp_shortlink_header() {
*
* @since 3.0.0
*
- * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
- * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
+ * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
+ * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $before Optional HTML to display before the link.
- * @param string $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;