X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/699231ae09f7057a4d0000cdf32e50a3df6a04ca..6c8f14c09105d0afa4c1574215c59b5021040e76:/wp-includes/link-template.php diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php index 0b92174d..de76f45a 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; } @@ -54,11 +54,11 @@ function user_trailingslashit($string, $type_of_url = '') { * * @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 ''; break; case 'id': @@ -77,7 +77,7 @@ function permalink_anchor($mode = 'id') { * @param bool $leavename Optional, defaults to false. Whether to keep post name or page name. * @return string */ -function get_permalink($id = 0, $leavename = false) { +function get_permalink( $id = 0, $leavename = false ) { $rewritecode = array( '%year%', '%monthnum%', @@ -96,7 +96,7 @@ function get_permalink($id = 0, $leavename = false) { $post = $id; $sample = true; } else { - $post = &get_post($id); + $post = get_post($id); $sample = false; } @@ -106,9 +106,9 @@ function get_permalink($id = 0, $leavename = false) { if ( $post->post_type == 'page' ) return get_page_link($post->ID, $leavename, $sample); elseif ( $post->post_type == 'attachment' ) - return get_attachment_link($post->ID); + return get_attachment_link( $post->ID, $leavename ); 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'); @@ -122,8 +122,10 @@ function get_permalink($id = 0, $leavename = false) { $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 ) + $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 @@ -176,7 +178,7 @@ function get_permalink($id = 0, $leavename = false) { 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; @@ -185,11 +187,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 +206,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); } /** @@ -230,24 +232,20 @@ function post_permalink( $post_id = 0, $deprecated = '' ) { * * @since 1.5.0 * - * @param int $id Optional. Post ID. + * @param mixed $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); + return apply_filters( 'page_link', $link, $post->ID, $sample ); } /** @@ -258,31 +256,32 @@ function get_page_link( $id = false, $leavename = false, $sample = false ) { * @since 2.1.0 * @access private * - * @param int $id Optional. Post ID. + * @param mixed $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' ) ); $link = $wp_rewrite->get_page_permastruct(); - if ( '' != $link && ( ( isset($post->post_status) && 'draft' != $post->post_status && 'pending' != $post->post_status ) || $sample ) ) { - if ( ! $leavename ) - $link = str_replace('%pagename%', get_page_uri($id), $link); + if ( !empty($link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) { + if ( ! $leavename ) { + $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 ); + return apply_filters( '_get_page_link', $link, $post->ID ); } /** @@ -292,38 +291,40 @@ function _get_page_link( $id = false, $leavename = false, $sample = false ) { * * @since 2.0.0 * - * @param int $id Optional. Post ID. + * @param mixed $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 ); - $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() && ( $post->post_parent > 0 ) && ( $post->post_parent != $post->ID ) ) { + $parent = get_post($post->post_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; // // 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; // // 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); + return apply_filters( 'attachment_link', $link, $post->ID ); } /** @@ -461,13 +462,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') ) { @@ -483,9 +484,9 @@ function get_post_comments_feed_link($post_id = '', $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); @@ -503,12 +504,12 @@ function get_post_comments_feed_link($post_id = '', $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'); @@ -556,7 +557,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 +573,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,11 +583,9 @@ 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; - $term_id = ( int ) $term_id; $term = get_term( $term_id, $taxonomy ); @@ -622,11 +621,10 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) { if ( 'category' == $taxonomy ) $link = apply_filters( 'category_feed_link', $link, $feed ); elseif ( 'post_tag' == $taxonomy ) - $link = apply_filters( 'category_feed_link', $link, $feed ); + $link = apply_filters( 'tag_feed_link', $link, $feed ); else $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy ); - return $link; } @@ -649,18 +647,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 +663,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 +821,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,11 +889,11 @@ 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' ) { - if ( !$post = &get_post( $id ) ) + if ( ! $post = get_post( $id ) ) return; if ( 'display' == $context ) @@ -818,7 +922,7 @@ function get_edit_post_link( $id = 0, $context = 'display' ) { * @param int $id Optional. Post ID. */ function edit_post_link( $link = null, $before = '', $after = '', $id = 0 ) { - if ( !$post = &get_post( $id ) ) + if ( !$post = get_post( $id ) ) return; if ( !$url = get_edit_post_link( $post->ID ) ) @@ -846,9 +950,9 @@ 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 ) ) + if ( !$post = get_post( $id ) ) return; $post_type_object = get_post_type_object( $post->post_type ); @@ -862,7 +966,7 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) ); - return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-{$post->post_type}_{$post->ID}" ), $post->ID, $force_delete ); + return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete ); } /** @@ -874,16 +978,10 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false * @return string */ function get_edit_comment_link( $comment_id = 0 ) { - $comment = &get_comment( $comment_id ); - $post = &get_post( $comment->comment_post_ID ); + $comment = get_comment( $comment_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 +998,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 . ''; + $link = '' . $link . ''; echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after; } @@ -954,72 +1047,115 @@ 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; } +/** + * 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' ) ); + + return apply_filters( 'get_edit_user_link', $link, $user->ID ); +} + // 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) { - global $post, $wpdb; +function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $previous = true ) { + global $wpdb; - if ( empty( $post ) ) + if ( ! $post = get_post() ) return null; $current_post_date = $post->post_date; $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 ) { + if ( ! is_object_in_taxonomy( $post->post_type, 'category' ) ) + return ''; $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids')); + if ( ! $cat_array || is_wp_error( $cat_array ) ) + return ''; $join .= " AND tt.taxonomy = 'category' AND tt.term_id IN (" . implode(',', $cat_array) . ")"; } $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 = ''; } @@ -1038,17 +1174,24 @@ function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $pre $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 ); $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 = "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 ( 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'); + + if ( $result ) + $result = get_post( $result ); + return $result; } @@ -1060,26 +1203,28 @@ 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) { - if ( $previous && is_attachment() && is_object( $GLOBALS['post'] ) ) - $post = & get_post($GLOBALS['post']->post_parent); + 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_cat, $excluded_categories, $previous ); if ( empty($post) ) return; if ( empty($post->post_title) ) - $post->post_title = $previous ? __('Previous Post') : __('Next Post'); + $post_title = $previous ? __('Previous Post') : __('Next Post'); + else + $post_title = $post->post_title; $date = mysql2date(get_option('date_format'), $post->post_date); - $title = str_replace('%title', $post->post_title, $title); + $title = str_replace('%title', $post_title, $title); $title = str_replace('%date', $date, $title); $title = apply_filters('the_title', $title, $post->ID); @@ -1097,8 +1242,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 +1253,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 +1269,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 +1282,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 +1292,45 @@ 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) { - global $post; - - if ( empty($post) || !is_single() || is_attachment() ) +function get_boundary_post( $in_same_cat = false, $excluded_categories = '', $start = true ) { + $post = get_post(); + if ( ! $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 +1340,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 +1354,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,48 +1370,52 @@ 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) { +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); + $post = get_post( get_post()->post_parent ); else - $post = get_adjacent_post($in_same_cat, $excluded_categories, $previous); + $post = get_adjacent_post( $in_same_cat, $excluded_categories, $previous ); - if ( !$post ) - return; - - $title = $post->post_title; + if ( ! $post ) { + $output = ''; + } else { + $title = $post->post_title; - if ( empty($post->post_title) ) - $title = $previous ? __('Previous Post') : __('Next Post'); + 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'; + $title = apply_filters( 'the_title', $title, $post->ID ); + $date = mysql2date( get_option( 'date_format' ), $post->post_date ); + $rel = $previous ? 'prev' : 'next'; - $string = ''; - $link = str_replace('%title', $title, $link); - $link = str_replace('%date', $date, $link); - $link = $string . $link . ''; + $string = ''; + $inlink = str_replace( '%title', $title, $link ); + $inlink = str_replace( '%date', $date, $inlink ); + $inlink = $string . $inlink . ''; - $format = str_replace('%link', $link, $format); + $output = str_replace( '%link', $inlink, $format ); + } $adjacent = $previous ? 'previous' : 'next'; - echo apply_filters( "{$adjacent}_post_link", $format, $link ); + + echo apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post ); } /** - * 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; @@ -1387,9 +1424,9 @@ function get_pagenum_link($pagenum = 1) { $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() ) { @@ -1411,8 +1448,8 @@ function get_pagenum_link($pagenum = 1) { $query_string = ''; } - $request = preg_replace( '|page/\d+/?$|', '', $request); - $request = preg_replace( '|^index\.php|', '', $request); + $request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request); + $request = preg_replace( '|^index\.php|i', '', $request); $request = ltrim($request, '/'); $base = trailingslashit( get_bloginfo( 'url' ) ); @@ -1421,7 +1458,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; @@ -1429,11 +1466,14 @@ function get_pagenum_link($pagenum = 1) { $result = apply_filters('get_pagenum_link', $result); - return $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. * @@ -1455,7 +1495,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 +1512,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 +1520,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 +1531,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 +1549,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 +1576,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,19 +1592,22 @@ 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 ) .''; + return '". preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) .''; } } @@ -1573,7 +1619,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 +1677,7 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { } /** - * Retrieve page numbers links. + * Retrieve comments page number link. * * @since 2.7.0 * @@ -1639,11 +1685,11 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { * @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 ) { @@ -1667,7 +1713,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 +1747,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 +1800,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()) { @@ -1788,7 +1834,7 @@ function paginate_comments_links($args = array()) { } /** - * Retrieve shortcut link. + * Retrieve the Press This bookmarklet link. * * Use this in 'a' element 'href' attribute. * @@ -1797,6 +1843,7 @@ function paginate_comments_links($args = array()) { * @return string */ function get_shortcut_link() { + // In case of breaking changes, version this. #WP20071 $link = "javascript: var d=document, w=window, @@ -1820,7 +1867,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,17 +1877,17 @@ 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', 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. * @@ -1849,23 +1896,30 @@ 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', 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() ) { + $url = get_option( 'home' ); + } else { + switch_to_blog( $blog_id ); + $url = get_option( 'home' ); + restore_current_blog(); + } - if ( empty( $blog_id ) || !is_multisite() ) - $home = get_option( 'home' ); - else - $home = get_blog_option( $blog_id, 'home' ); + if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) { + if ( is_ssl() && ! is_admin() ) + $scheme = 'https'; + else + $scheme = parse_url( $url, PHP_URL_SCHEME ); + } - $url = str_replace( 'http://', "$scheme://", $home ); + $url = set_url_scheme( $url, $scheme ); - if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) + if ( ! empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) $url .= '/' . ltrim( $path, '/' ); return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); @@ -1874,7 +1928,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,17 +1938,17 @@ 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. 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. * @@ -1903,34 +1957,24 @@ 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', '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(); + } - $url = str_replace( 'http://', "{$scheme}://", $url ); + $url = set_url_scheme( $url, $scheme ); - if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) + if ( ! empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) $url .= '/' . ltrim( $path, '/' ); - return apply_filters( 'site_url', $url, $path, $orig_scheme, $blog_id ); + return apply_filters( 'site_url', $url, $path, $scheme, $blog_id ); } /** @@ -1939,12 +1983,12 @@ 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); + return get_admin_url( null, $path, $scheme ); } /** @@ -1954,17 +1998,17 @@ 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); - if ( !empty($path) && is_string($path) && strpos($path, '..') === false ) - $url .= ltrim($path, '/'); + if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) + $url .= ltrim( $path, '/' ); - return apply_filters('admin_url', $url, $path, $blog_id); + return apply_filters( 'admin_url', $url, $path, $blog_id ); } /** @@ -1995,9 +2039,7 @@ function includes_url($path = '') { * @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 ) $url .= '/' . ltrim($path, '/'); @@ -2029,8 +2071,8 @@ function plugins_url($path = '', $plugin = '') { 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)); @@ -2047,7 +2089,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,41 +2097,30 @@ 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. 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' ); - } - - $url = 'http://' . $current_site->domain . $current_site->path; - - $url = str_replace( 'http://', "{$scheme}://", $url ); + 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 ( ! empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) + $url .= ltrim( $path, '/' ); - return apply_filters('network_site_url', $url, $path, $orig_scheme); + 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. * @@ -2097,25 +2128,26 @@ 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', 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); $orig_scheme = $scheme; - if ( !in_array($scheme, array('http', 'https')) ) - $scheme = is_ssl() && !is_admin() ? 'https' : 'http'; - - $url = 'http://' . $current_site->domain . $current_site->path; + if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) + $scheme = is_ssl() && ! is_admin() ? 'https' : 'http'; - $url = str_replace( 'http://', "$scheme://", $url ); + 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 ( ! empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) $url .= ltrim( $path, '/' ); return apply_filters( 'network_home_url', $url, $path, $orig_scheme); @@ -2127,12 +2159,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 +2176,135 @@ 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); +} + +/** + * 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 ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) { + if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) ) + $scheme = 'https'; + elseif ( ( 'login' == $scheme ) && force_ssl_admin() ) + $scheme = 'https'; + elseif ( ( 'admin' == $scheme ) && force_ssl_admin() ) + $scheme = 'https'; + else + $scheme = ( is_ssl() ? 'https' : 'http' ); + } + + if ( 'relative' == $scheme ) + $url = preg_replace( '#^.+://[^/]*#', '', $url ); + else + $url = preg_replace( '#^.+://#', $scheme . '://', $url ); + + 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 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 @@ -2155,21 +2318,25 @@ function rel_canonical() { return; $link = get_permalink( $id ); + + if ( $page = get_query_var('cpage') ) + $link = get_comments_pagenum_link( $page ); + echo "\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 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 +2368,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 +2382,7 @@ function wp_shortlink_wp_head() { if ( empty( $shortlink ) ) return; - echo "\n"; + echo "\n"; } /** @@ -2228,7 +2395,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,19 +2415,19 @@ 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; + $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 ); @@ -2270,5 +2437,3 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { echo $before, $link, $after; } } - -?>