', $args['next_text'] );
+
+ // Only add markup if there's somewhere to navigate to.
+ if ( $previous || $next ) {
+ $navigation = _navigation_markup( $previous . $next, 'post-navigation', $args['screen_reader_text'] );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display navigation to next/previous post when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args Optional. See {@see get_the_post_navigation()} for available
+ * arguments. Default empty array.
+ */
+function the_post_navigation( $args = array() ) {
+ echo get_the_post_navigation( $args );
+}
+
+/**
+ * Return navigation to next/previous set of posts when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @global WP_Query $wp_query WordPress Query object.
+ *
+ * @param array $args {
+ * Optional. Default posts navigation arguments. Default empty array.
+ *
+ * @type string $prev_text Anchor text to display in the previous posts link.
+ * Default 'Older posts'.
+ * @type string $next_text Anchor text to display in the next posts link.
+ * Default 'Newer posts'.
+ * @type string $screen_reader_text Screen reader text for nav element.
+ * Default 'Posts navigation'.
+ * }
+ * @return string Markup for posts links.
+ */
+function get_the_posts_navigation( $args = array() ) {
+ $navigation = '';
+
+ // Don't print empty markup if there's only one page.
+ if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+ $args = wp_parse_args( $args, array(
+ 'prev_text' => __( 'Older posts' ),
+ 'next_text' => __( 'Newer posts' ),
+ 'screen_reader_text' => __( 'Posts navigation' ),
+ ) );
+
+ $next_link = get_previous_posts_link( $args['next_text'] );
+ $prev_link = get_next_posts_link( $args['prev_text'] );
+
+ if ( $prev_link ) {
+ $navigation .= '
' . $prev_link . '
';
+ }
+
+ if ( $next_link ) {
+ $navigation .= '
' . $next_link . '
';
+ }
+
+ $navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display navigation to next/previous set of posts when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args Optional. See {@see get_the_posts_navigation()} for available
+ * arguments. Default empty array.
+ */
+function the_posts_navigation( $args = array() ) {
+ echo get_the_posts_navigation( $args );
+}
+
+/**
+ * Return a paginated navigation to next/previous set of posts,
+ * when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args {
+ * Optional. Default pagination arguments, {@see paginate_links()}.
+ *
+ * @type string $screen_reader_text Screen reader text for navigation element.
+ * Default 'Posts navigation'.
+ * }
+ * @return string Markup for pagination links.
+ */
+function get_the_posts_pagination( $args = array() ) {
+ $navigation = '';
+
+ // Don't print empty markup if there's only one page.
+ if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+ $args = wp_parse_args( $args, array(
+ 'mid_size' => 1,
+ 'prev_text' => _x( 'Previous', 'previous post' ),
+ 'next_text' => _x( 'Next', 'next post' ),
+ 'screen_reader_text' => __( 'Posts navigation' ),
+ ) );
+
+ // Make sure we get a string back. Plain is the next best thing.
+ if ( isset( $args['type'] ) && 'array' == $args['type'] ) {
+ $args['type'] = 'plain';
+ }
+
+ // Set up paginated links.
+ $links = paginate_links( $args );
+
+ if ( $links ) {
+ $navigation = _navigation_markup( $links, 'pagination', $args['screen_reader_text'] );
+ }
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display a paginated navigation to next/previous set of posts,
+ * when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args Optional. See {@see get_the_posts_pagination()} for available arguments.
+ * Default empty array.
+ */
+function the_posts_pagination( $args = array() ) {
+ echo get_the_posts_pagination( $args );
+}
+
+/**
+ * Wraps passed links in navigational markup.
+ *
+ * @since 4.1.0
+ * @access private
+ *
+ * @param string $links Navigational links.
+ * @param string $class Optional. Custom class for nav element. Default: 'posts-navigation'.
+ * @param string $screen_reader_text Optional. Screen reader text for nav element. Default: 'Posts navigation'.
+ * @return string Navigation template tag.
+ */
+function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) {
+ if ( empty( $screen_reader_text ) ) {
+ $screen_reader_text = __( 'Posts navigation' );
+ }
+
+ $template = '
+ ';
+
+ return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
+}
+
+/**
+ * Retrieve comments page number link.
*
* @since 2.7.0
*
* @param int $pagenum Optional. Page number.
- * @return string
+ * @param int $max_page Optional. The maximum number of comment pages.
+ * @return string The comments page number link URL.
*/
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 ) {
@@ -1766,19 +2401,26 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
$result .= '#comments';
- $result = apply_filters('get_comments_pagenum_link', $result);
+ /**
+ * Filter the comments page number link for the current request.
+ *
+ * @since 2.7.0
+ *
+ * @param string $result The comments page number link.
+ */
+ $result = apply_filters( 'get_comments_pagenum_link', $result );
return $result;
}
/**
- * Return the link to next comments pages.
+ * Return the link to next comments page.
*
* @since 2.7.1
*
* @param string $label Optional. Label for link text.
* @param int $max_page Optional. Max page.
- * @return string|null
+ * @return string|null HTML-formatted link for the next page of comments.
*/
function get_next_comments_link( $label = '', $max_page = 0 ) {
global $wp_query;
@@ -1802,11 +2444,18 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
if ( empty($label) )
$label = __('Newer Comments »');
+ /**
+ * Filter the anchor tag attributes for the next comments page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
return ''. preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .'';
}
/**
- * Display the link to next comments pages.
+ * Display the link to next comments page.
*
* @since 2.7.0
*
@@ -1823,7 +2472,7 @@ function next_comments_link( $label = '', $max_page = 0 ) {
* @since 2.7.1
*
* @param string $label Optional. Label for comments link text.
- * @return string|null
+ * @return string|null HTML-formatted link for the previous page of comments.
*/
function get_previous_comments_link( $label = '' ) {
if ( !is_singular() || !get_option('page_comments') )
@@ -1839,6 +2488,13 @@ function get_previous_comments_link( $label = '' ) {
if ( empty($label) )
$label = __('« Older Comments');
+ /**
+ * Filter the anchor tag attributes for the previous comments page link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $attributes Attributes for the anchor tag.
+ */
return '' . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&$1', $label) .'';
}
@@ -1859,7 +2515,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()) {
@@ -1893,15 +2549,16 @@ function paginate_comments_links($args = array()) {
}
/**
- * Retrieve shortcut link.
+ * Retrieve the Press This bookmarklet link.
*
* Use this in 'a' element 'href' attribute.
*
* @since 2.6.0
*
- * @return string
+ * @return string The Press This bookmarklet link URL.
*/
function get_shortcut_link() {
+ // In case of breaking changes, version this. #WP20071
$link = "javascript:
var d=document,
w=window,
@@ -1919,225 +2576,270 @@ function get_shortcut_link() {
$link = str_replace(array("\r", "\n", "\t"), '', $link);
- return apply_filters('shortcut_link', $link);
+ /**
+ * Filter the Press This bookmarklet link.
+ *
+ * @since 2.6.0
+ *
+ * @param string $link The Press This bookmarklet link.
+ */
+ return apply_filters( 'shortcut_link', $link );
}
/**
* Retrieve the home url for the current site.
*
- * 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.
+ * Returns the 'home' option with the appropriate protocol, 'https' if
+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is overridden.
*
- * @package WordPress
* @since 3.0.0
*
- * @uses get_home_url()
- *
- * @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
+ * @param string $path Optional. Path relative to the home url. Default empty.
+ * @param string $scheme Optional. Scheme to give the home url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
* @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
- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
+ * Returns the 'home' option with the appropriate protocol, 'https' if
+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
- * @param int $blog_id (optional) Blog ID. Defaults to current blog.
- * @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
- * @return string Home url link with optional path appended.
+ * @param int $blog_id Optional. Blog ID. Default null (current blog).
+ * @param string $path Optional. Path relative to the home URL. Default empty.
+ * @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
+ * 'http', 'https', 'relative', or null. Default null.
+ * @return string Home URL link with optional path appended.
*/
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
$orig_scheme = $scheme;
- if ( !in_array( $scheme, array( 'http', 'https' ) ) )
- $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
-
- if ( empty( $blog_id ) || !is_multisite() )
+ if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'home' );
- else
- $url = get_blog_option( $blog_id, 'home' );
+ } else {
+ switch_to_blog( $blog_id );
+ $url = get_option( 'home' );
+ restore_current_blog();
+ }
- if ( 'http' != $scheme )
- $url = str_replace( 'http://', "$scheme://", $url );
+ if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
+ if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] )
+ $scheme = 'https';
+ else
+ $scheme = parse_url( $url, PHP_URL_SCHEME );
+ }
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ $url = set_url_scheme( $url, $scheme );
+
+ if ( $path && is_string( $path ) )
$url .= '/' . ltrim( $path, '/' );
+ /**
+ * Filter the home URL.
+ *
+ * @since 3.0.0
+ *
+ * @param string $url The complete home URL including scheme and path.
+ * @param string $path Path relative to the home URL. Blank string if no path is specified.
+ * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', 'relative' or null.
+ * @param int|null $blog_id Blog ID, or null for the current blog.
+ */
return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
}
/**
* Retrieve the site url for the current site.
*
- * Returns the 'site_url' option with the appropriate protocol, 'https' if
+ * Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
- * @since 2.6.0
- *
- * @uses get_site_url()
+ * @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 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
- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
- * overridden.
+ * Returns the 'site_url' option with the appropriate protocol, 'https' if
+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is overridden.
*
- * @package WordPress
* @since 3.0.0
*
- * @param int $blog_id (optional) Blog ID. Defaults to current blog.
- * @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
+ * @param int $blog_id Optional. Blog ID. Default null (current site).
+ * @param string $path Optional. Path relative to the site url. Default empty.
+ * @param string $scheme Optional. Scheme to give the site url context. Accepts
+ * 'http', 'https', 'login', 'login_post', 'admin', or
+ * 'relative'. Default null.
* @return string Site url link with optional path appended.
*/
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
- // should the list of allowed schemes be maintained elsewhere?
- $orig_scheme = $scheme;
- if ( !in_array( $scheme, array( 'http', 'https' ) ) ) {
- if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) )
- $scheme = 'https';
- elseif ( ( 'login' == $scheme ) && force_ssl_admin() )
- $scheme = 'https';
- elseif ( ( 'admin' == $scheme ) && force_ssl_admin() )
- $scheme = 'https';
- else
- $scheme = ( is_ssl() ? 'https' : 'http' );
- }
-
- if ( empty( $blog_id ) || !is_multisite() )
+ if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'siteurl' );
- else
- $url = get_blog_option( $blog_id, 'siteurl' );
+ } else {
+ switch_to_blog( $blog_id );
+ $url = get_option( 'siteurl' );
+ restore_current_blog();
+ }
- if ( 'http' != $scheme )
- $url = str_replace( 'http://', "{$scheme}://", $url );
+ $url = set_url_scheme( $url, $scheme );
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ if ( $path && is_string( $path ) )
$url .= '/' . ltrim( $path, '/' );
- return apply_filters( 'site_url', $url, $path, $orig_scheme, $blog_id );
+ /**
+ * Filter the site URL.
+ *
+ * @since 2.7.0
+ *
+ * @param string $url The complete site URL including scheme and path.
+ * @param string $path Path relative to the site URL. Blank string if no path is specified.
+ * @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login',
+ * 'login_post', 'admin', 'relative' or null.
+ * @param int|null $blog_id Blog ID, or null for the current blog.
+ */
+ return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
}
/**
* Retrieve the url to the admin area for the current site.
*
- * @package WordPress
* @since 2.6.0
*
- * @param string $path Optional path relative to the admin url
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function admin_url( $path = '', $scheme = 'admin' ) {
- return get_admin_url(null, $path, $scheme);
+ return get_admin_url( null, $path, $scheme );
}
/**
- * Retrieve the url to the admin area for a given site.
+ * Retrieves the url to the admin area for a given site.
*
- * @package WordPress
* @since 3.0.0
*
- * @param int $blog_id (optional) Blog ID. Defaults to current blog.
- * @param string $path Optional path relative to the admin url
- * @param string $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
+ * @param int $blog_id Optional. Blog ID. Default null (current site).
+ * @param string $path Optional. Path relative to the admin url. Default empty.
+ * @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https',
+ * to force those schemes. Default 'admin', which obeys
+ * {@see force_ssl_admin()} and {@see is_ssl()}.
+ * @return string Admin url link with optional path appended.
*/
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
$url = get_site_url($blog_id, 'wp-admin/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
- $url .= ltrim($path, '/');
+ if ( $path && is_string( $path ) )
+ $url .= ltrim( $path, '/' );
- return apply_filters('admin_url', $url, $path, $blog_id);
+ /**
+ * Filter the admin area URL.
+ *
+ * @since 2.8.0
+ *
+ * @param string $url The complete admin area URL including scheme and path.
+ * @param string $path Path relative to the admin area URL. Blank string if no path is specified.
+ * @param int|null $blog_id Blog ID, or null for the current blog.
+ */
+ return apply_filters( 'admin_url', $url, $path, $blog_id );
}
/**
* Retrieve the url to the includes directory.
*
- * @package WordPress
* @since 2.6.0
*
* @param string $path Optional. Path relative to the includes url.
+ * @param string $scheme Optional. Scheme to give the includes url context.
* @return string Includes url link with optional path appended.
*/
-function includes_url($path = '') {
- $url = site_url() . '/' . WPINC . '/';
+function includes_url( $path = '', $scheme = null ) {
+ $url = site_url( '/' . WPINC . '/', $scheme );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ if ( $path && is_string( $path ) )
$url .= ltrim($path, '/');
- return apply_filters('includes_url', $url, $path);
+ /**
+ * Filter the URL to the includes directory.
+ *
+ * @since 2.8.0
+ *
+ * @param string $url The complete URL to the includes directory including scheme and path.
+ * @param string $path Path relative to the URL to the wp-includes directory. Blank string
+ * if no path is specified.
+ */
+ return apply_filters( 'includes_url', $url, $path );
}
/**
* Retrieve the url to the content directory.
*
- * @package WordPress
* @since 2.6.0
*
* @param string $path Optional. Path relative to the content url.
* @return string Content url link with optional path appended.
*/
function content_url($path = '') {
- $url = WP_CONTENT_URL;
- if ( 0 === strpos($url, 'http') && is_ssl() )
- $url = str_replace( 'http://', 'https://', $url );
+ $url = set_url_scheme( WP_CONTENT_URL );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ if ( $path && is_string( $path ) )
$url .= '/' . ltrim($path, '/');
- return apply_filters('content_url', $url, $path);
+ /**
+ * Filter the URL to the content directory.
+ *
+ * @since 2.8.0
+ *
+ * @param string $url The complete URL to the content directory including scheme and path.
+ * @param string $path Path relative to the URL to the content directory. Blank string
+ * if no path is specified.
+ */
+ return apply_filters( 'content_url', $url, $path);
}
/**
- * Retrieve the url to the plugins directory or to a specific file within that directory.
- * You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name.
+ * Retrieve a URL within the plugins or mu-plugins directory.
+ *
+ * Defaults to the plugins directory URL if no arguments are supplied.
*
- * @package WordPress
* @since 2.6.0
*
- * @param string $path Optional. Path relative to the plugins url.
- * @param string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__
- * @return string Plugins url link with optional path appended.
+ * @param string $path Optional. Extra path appended to the end of the URL, including
+ * the relative directory if $plugin is supplied. Default empty.
+ * @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin.
+ * The URL will be relative to its directory. Default empty.
+ * Typically this is done by passing `__FILE__` as the argument.
+ * @return string Plugins URL link with optional paths appended.
*/
-function plugins_url($path = '', $plugin = '') {
+function plugins_url( $path = '', $plugin = '' ) {
- $mu_plugin_dir = WPMU_PLUGIN_DIR;
- foreach ( array('path', 'plugin', 'mu_plugin_dir') as $var ) {
- $$var = str_replace('\\' ,'/', $$var); // sanitize for Win32 installs
- $$var = preg_replace('|/+|', '/', $$var);
- }
+ $path = wp_normalize_path( $path );
+ $plugin = wp_normalize_path( $plugin );
+ $mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );
if ( !empty($plugin) && 0 === strpos($plugin, $mu_plugin_dir) )
$url = WPMU_PLUGIN_URL;
else
$url = WP_PLUGIN_URL;
- if ( 0 === strpos($url, 'http') && is_ssl() )
- $url = str_replace( 'http://', 'https://', $url );
+
+ $url = set_url_scheme( $url );
if ( !empty($plugin) && is_string($plugin) ) {
$folder = dirname(plugin_basename($plugin));
@@ -2145,94 +2847,118 @@ function plugins_url($path = '', $plugin = '') {
$url .= '/' . ltrim($folder, '/');
}
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ if ( $path && is_string( $path ) )
$url .= '/' . ltrim($path, '/');
- return apply_filters('plugins_url', $url, $path, $plugin);
+ /**
+ * Filter the URL to the plugins directory.
+ *
+ * @since 2.8.0
+ *
+ * @param string $url The complete URL to the plugins directory including scheme and path.
+ * @param string $path Path relative to the URL to the plugins directory. Blank string
+ * if no path is specified.
+ * @param string $plugin The plugin file path to be relative to. Blank string if no plugin
+ * is specified.
+ */
+ return apply_filters( 'plugins_url', $url, $path, $plugin );
}
/**
* Retrieve the site url for the current network.
*
- * Returns the site url with the appropriate protocol, 'https' if
+ * Returns the site url with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
* @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
+ * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
*/
function network_site_url( $path = '', $scheme = null ) {
- global $current_site;
-
- if ( !is_multisite() )
+ if ( ! is_multisite() )
return site_url($path, $scheme);
- $orig_scheme = $scheme;
- if ( !in_array($scheme, array('http', 'https')) ) {
- if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) )
- $scheme = 'https';
- elseif ( ('login' == $scheme) && ( force_ssl_admin() ) )
- $scheme = 'https';
- elseif ( ('admin' == $scheme) && force_ssl_admin() )
- $scheme = 'https';
- else
- $scheme = ( is_ssl() ? 'https' : 'http' );
- }
+ $current_site = get_current_site();
- $url = $scheme . '://' . $current_site->domain . $current_site->path;
+ if ( 'relative' == $scheme )
+ $url = $current_site->path;
+ else
+ $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
- $url .= ltrim($path, '/');
+ if ( $path && is_string( $path ) )
+ $url .= ltrim( $path, '/' );
- return apply_filters('network_site_url', $url, $path, $orig_scheme);
+ /**
+ * Filter the network site URL.
+ *
+ * @since 3.0.0
+ *
+ * @param string $url The complete network site URL including scheme and path.
+ * @param string $path Path relative to the network site URL. Blank string if
+ * no path is specified.
+ * @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https',
+ * 'relative' or null.
+ */
+ return apply_filters( 'network_site_url', $url, $path, $scheme );
}
/**
- * Retrieve the home url for the current network.
+ * Retrieves the home url for the current network.
*
- * Returns the home url with the appropriate protocol, 'https' if
- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
+ * Returns the home url with the appropriate protocol, 'https' {@see is_ssl()}
+ * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
* overridden.
*
- * @package WordPress
* @since 3.0.0
*
- * @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
+ * @param string $path Optional. Path relative to the home url. Default empty.
+ * @param string $scheme Optional. Scheme to give the home url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
* @return string Home url link with optional path appended.
*/
function network_home_url( $path = '', $scheme = null ) {
- global $current_site;
-
- if ( !is_multisite() )
+ if ( ! is_multisite() )
return home_url($path, $scheme);
+ $current_site = get_current_site();
$orig_scheme = $scheme;
- if ( !in_array($scheme, array('http', 'https')) )
- $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
+ if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) )
+ $scheme = is_ssl() && ! is_admin() ? 'https' : 'http';
- $url = $scheme . '://' . $current_site->domain . $current_site->path;
+ if ( 'relative' == $scheme )
+ $url = $current_site->path;
+ else
+ $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
- if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
+ if ( $path && is_string( $path ) )
$url .= ltrim( $path, '/' );
+ /**
+ * Filter the network home URL.
+ *
+ * @since 3.0.0
+ *
+ * @param string $url The complete network home URL including scheme and path.
+ * @param string $path Path relative to the network home URL. Blank string
+ * if no path is specified.
+ * @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https',
+ * 'relative' or null.
+ */
return apply_filters( 'network_home_url', $url, $path, $orig_scheme);
}
/**
* Retrieve the url to the admin area for the network.
*
- * @package WordPress
* @since 3.0.0
*
- * @param string $path Optional path relative to the admin url
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function network_admin_url( $path = '', $scheme = 'admin' ) {
if ( ! is_multisite() )
@@ -2240,40 +2966,56 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/network/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ if ( $path && is_string( $path ) )
$url .= ltrim($path, '/');
- return apply_filters('network_admin_url', $url, $path);
+ /**
+ * Filter the network admin URL.
+ *
+ * @since 3.0.0
+ *
+ * @param string $url The complete network admin URL including scheme and path.
+ * @param string $path Path relative to the network admin URL. Blank string if
+ * no path is specified.
+ */
+ return apply_filters( 'network_admin_url', $url, $path );
}
/**
* Retrieve the url to the admin area for the current user.
*
- * @package WordPress
* @since 3.0.0
*
- * @param string $path Optional path relative to the admin url
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/user/', $scheme);
- if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
+ if ( $path && is_string( $path ) )
$url .= ltrim($path, '/');
- return apply_filters('user_admin_url', $url, $path);
+ /**
+ * Filter the user admin URL for the current user.
+ *
+ * @since 3.1.0
+ *
+ * @param string $url The complete URL including scheme and path.
+ * @param string $path Path relative to the URL. Blank string if
+ * no path is specified.
+ */
+ return apply_filters( 'user_admin_url', $url, $path );
}
/**
* Retrieve the url to the admin area for either the current blog or the network depending on context.
*
- * @package WordPress
* @since 3.1.0
*
- * @param string $path Optional path relative to the admin url
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Admin url link with optional path appended
+ * @return string Admin url link with optional path appended.
*/
function self_admin_url($path = '', $scheme = 'admin') {
if ( is_network_admin() )
@@ -2284,22 +3026,67 @@ function self_admin_url($path = '', $scheme = 'admin') {
return admin_url($path, $scheme);
}
+/**
+ * Set the scheme for a URL
+ *
+ * @since 3.4.0
+ *
+ * @param string $url Absolute url that includes a scheme
+ * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
+ * @return string $url URL with chosen scheme.
+ */
+function set_url_scheme( $url, $scheme = null ) {
+ $orig_scheme = $scheme;
+
+ if ( ! $scheme ) {
+ $scheme = is_ssl() ? 'https' : 'http';
+ } elseif ( $scheme === 'admin' || $scheme === 'login' || $scheme === 'login_post' || $scheme === 'rpc' ) {
+ $scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http';
+ } elseif ( $scheme !== 'http' && $scheme !== 'https' && $scheme !== 'relative' ) {
+ $scheme = is_ssl() ? 'https' : 'http';
+ }
+
+ $url = trim( $url );
+ if ( substr( $url, 0, 2 ) === '//' )
+ $url = 'http:' . $url;
+
+ if ( 'relative' == $scheme ) {
+ $url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) );
+ if ( $url !== '' && $url[0] === '/' )
+ $url = '/' . ltrim($url , "/ \t\n\r\0\x0B" );
+ } else {
+ $url = preg_replace( '#^\w+://#', $scheme . '://', $url );
+ }
+
+ /**
+ * Filter the resulting URL after setting the scheme.
+ *
+ * @since 3.4.0
+ *
+ * @param string $url The complete URL including scheme and path.
+ * @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'.
+ * @param string $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
+ * 'login_post', 'admin', 'rpc', or 'relative'.
+ */
+ return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );
+}
+
/**
* Get the URL to the user's dashboard.
*
- * If a user does not belong to any sites, the global user dashboard is used. If the user belongs to the current site,
- * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
+ * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
+ * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
* primary blog is returned.
*
* @since 3.1.0
*
- * @param int $user_id User ID
- * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
+ * @param int $user_id Optional. User ID. Defaults to current user.
+ * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Dashboard url link with optional path appended
+ * @return string Dashboard url link with optional path appended.
*/
-function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
- $user_id = (int) $user_id;
+function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
+ $user_id = $user_id ? (int) $user_id : get_current_user_id();
$blogs = get_blogs_of_user( $user_id );
if ( ! is_super_admin() && empty($blogs) ) {
@@ -2319,6 +3106,17 @@ function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
}
}
+ /**
+ * Filter the dashboard URL for a user.
+ *
+ * @since 3.1.0
+ *
+ * @param string $url The complete URL including scheme and path.
+ * @param int $user_id The user ID.
+ * @param string $path Path relative to the URL. Blank string if no path is specified.
+ * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login',
+ * 'login_post', 'admin', 'relative' or null.
+ */
return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme);
}
@@ -2327,27 +3125,37 @@ function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
*
* @since 3.1.0
*
- * @param int $user User ID
- * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
- * @return string Dashboard url link with optional path appended
+ * @param int $user_id Optional. User ID. Defaults to current user.
+ * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
+ * 'http' or 'https' can be passed to force those schemes.
+ * @return string Dashboard url link with optional path appended.
*/
-function get_edit_profile_url( $user, $scheme = 'admin' ) {
- $user = (int) $user;
+function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
+ $user_id = $user_id ? (int) $user_id : get_current_user_id();
if ( is_user_admin() )
$url = user_admin_url( 'profile.php', $scheme );
elseif ( is_network_admin() )
$url = network_admin_url( 'profile.php', $scheme );
else
- $url = get_dashboard_url( $user, 'profile.php', $scheme );
+ $url = get_dashboard_url( $user_id, 'profile.php', $scheme );
- return apply_filters( 'edit_profile_url', $url, $user, $scheme);
+ /**
+ * Filter the URL for a user's profile editor.
+ *
+ * @since 3.1.0
+ *
+ * @param string $url The complete URL including scheme and path.
+ * @param int $user_id The user ID.
+ * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login',
+ * 'login_post', 'admin', 'relative' or null.
+ */
+ return apply_filters( 'edit_profile_url', $url, $user_id, $scheme);
}
/**
- * Output rel=canonical for singular queries
+ * Output rel=canonical for singular queries.
*
- * @package WordPress
* @since 2.9.0
*/
function rel_canonical() {
@@ -2359,59 +3167,90 @@ 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 int $id A post or blog id. Default is 0, which means the current post or blog.
* @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
* @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
* @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
*/
function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
- // Allow plugins to short-circuit this function.
- $shortlink = apply_filters('pre_get_shortlink', false, $id, $context, $allow_slugs);
+ /**
+ * Filter whether to preempt generating a shortlink for the given post.
+ *
+ * Passing a truthy value to the filter will effectively short-circuit the
+ * shortlink-generation process, returning that value instead.
+ *
+ * @since 3.0.0
+ *
+ * @param bool|string $return Short-circuit return value. Either false or a URL string.
+ * @param int $id Post ID, or 0 for the current post.
+ * @param string $context The context for the link. One of 'post' or 'query',
+ * @param bool $allow_slugs Whether to allow post slugs in the shortlink.
+ */
+ $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );
+
if ( false !== $shortlink )
return $shortlink;
global $wp_query;
$post_id = 0;
- if ( 'query' == $context && is_single() ) {
+ if ( 'query' == $context && is_singular() ) {
$post_id = $wp_query->get_queried_object_id();
+ $post = get_post( $post_id );
} elseif ( 'post' == $context ) {
- $post = get_post($id);
- $post_id = $post->ID;
+ $post = get_post( $id );
+ if ( ! empty( $post->ID ) )
+ $post_id = $post->ID;
}
$shortlink = '';
- // Return p= link for posts.
- if ( !empty($post_id) && '' != get_option('permalink_structure') ) {
- $post = get_post($post_id);
- if ( isset($post->post_type) && 'post' == $post->post_type )
- $shortlink = home_url('?p=' . $post->ID);
+ // Return p= link for all public post types.
+ if ( ! empty( $post_id ) ) {
+ $post_type = get_post_type_object( $post->post_type );
+
+ if ( 'page' === $post->post_type && $post->ID == get_option( 'page_on_front' ) && 'page' == get_option( 'show_on_front' ) ) {
+ $shortlink = home_url( '/' );
+ } elseif ( $post_type->public ) {
+ $shortlink = home_url( '?p=' . $post_id );
+ }
}
- return apply_filters('get_shortlink', $shortlink, $id, $context, $allow_slugs);
+ /**
+ * Filter the shortlink for a post.
+ *
+ * @since 3.0.0
+ *
+ * @param string $shortlink Shortlink URL.
+ * @param int $id Post ID, or 0 for the current post.
+ * @param string $context The context for the link. One of 'post' or 'query',
+ * @param bool $allow_slugs Whether to allow post slugs in the shortlink. Not used by default.
+ */
+ return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs );
}
/**
- * Inject rel=sortlink into head if a shortlink is defined for the current page.
+ * Inject rel=shortlink into head if a shortlink is defined for the current page.
*
* Attached to the wp_head action.
*
* @since 3.0.0
- *
- * @uses wp_get_shortlink()
*/
function wp_shortlink_wp_head() {
$shortlink = wp_get_shortlink( 0, 'query' );
@@ -2428,8 +3267,6 @@ function wp_shortlink_wp_head() {
* Attached to the wp action.
*
* @since 3.0.0
- *
- * @uses wp_get_shortlink()
*/
function wp_shortlink_header() {
if ( headers_sent() )
@@ -2452,27 +3289,36 @@ 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 );
if ( !empty( $shortlink ) ) {
$link = '' . $text . '';
+
+ /**
+ * Filter the shortlink anchor tag for a post.
+ *
+ * @since 3.0.0
+ *
+ * @param string $link Shortlink anchor tag.
+ * @param string $shortlink Shortlink URL.
+ * @param string $text Shortlink's text.
+ * @param string $title Shortlink's title attribute.
+ */
$link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title );
echo $before, $link, $after;
}
}
-
-?>