',
+ $args['next_text'],
+ $args['in_same_term'],
+ $args['excluded_terms'],
+ $args['taxonomy']
+ );
// Only add markup if there's somewhere to navigate to.
if ( $previous || $next ) {
@@ -2366,6 +2554,26 @@ function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader
%3$s
';
+ /**
+ * Filter the navigation markup template.
+ *
+ * Note: The filtered template HTML must contain specifiers for the navigation
+ * class (%1$s), the screen-reader-text value (%2$s), and placement of the
+ * navigation links (%3$s):
+ *
+ *
+ *
+ * @since 4.4.0
+ *
+ * @param string $template The default template.
+ * @param string $class The class passed by the calling function.
+ * @return string Navigation template.
+ */
+ $template = apply_filters( 'navigation_markup_template', $template, $class );
+
return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
}
@@ -2374,7 +2582,9 @@ function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader
*
* @since 2.7.0
*
- * @param int $pagenum Optional. Page number.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $pagenum Optional. Page number.
* @param int $max_page Optional. The maximum number of comment pages.
* @return string The comments page number link URL.
*/
@@ -2388,13 +2598,13 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
if ( 'newest' == get_option('default_comments_page') ) {
if ( $pagenum != $max_page ) {
if ( $wp_rewrite->using_permalinks() )
- $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
+ $result = user_trailingslashit( trailingslashit($result) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged');
else
$result = add_query_arg( 'cpage', $pagenum, $result );
}
} elseif ( $pagenum > 1 ) {
if ( $wp_rewrite->using_permalinks() )
- $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
+ $result = user_trailingslashit( trailingslashit($result) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged');
else
$result = add_query_arg( 'cpage', $pagenum, $result );
}
@@ -2408,9 +2618,7 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
*
* @param string $result The comments page number link.
*/
- $result = apply_filters( 'get_comments_pagenum_link', $result );
-
- return $result;
+ return apply_filters( 'get_comments_pagenum_link', $result );
}
/**
@@ -2418,18 +2626,24 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
*
* @since 2.7.1
*
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
- * @return string|null HTML-formatted link for the next page of comments.
+ * @global WP_Query $wp_query
+ *
+ * @param string $label Optional. Label for link text.
+ * @param int $max_page Optional. Max page.
+ * @return string|void HTML-formatted link for the next page of comments.
*/
function get_next_comments_link( $label = '', $max_page = 0 ) {
global $wp_query;
- if ( !is_singular() || !get_option('page_comments') )
+ if ( ! is_singular() )
return;
$page = get_query_var('cpage');
+ if ( ! $page ) {
+ $page = 1;
+ }
+
$nextpage = intval($page) + 1;
if ( empty($max_page) )
@@ -2459,8 +2673,8 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
*
* @since 2.7.0
*
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
+ * @param string $label Optional. Label for link text.
+ * @param int $max_page Optional. Max page.
*/
function next_comments_link( $label = '', $max_page = 0 ) {
echo get_next_comments_link( $label, $max_page );
@@ -2472,10 +2686,10 @@ function next_comments_link( $label = '', $max_page = 0 ) {
* @since 2.7.1
*
* @param string $label Optional. Label for comments link text.
- * @return string|null HTML-formatted link for the previous page of comments.
+ * @return string|void HTML-formatted link for the previous page of comments.
*/
function get_previous_comments_link( $label = '' ) {
- if ( !is_singular() || !get_option('page_comments') )
+ if ( ! is_singular() )
return;
$page = get_query_var('cpage');
@@ -2515,13 +2729,15 @@ function previous_comments_link( $label = '' ) {
* @see paginate_links()
* @since 2.7.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string|array $args Optional args. See paginate_links().
- * @return string Markup for pagination links.
-*/
+ * @return string|void Markup for pagination links.
+ */
function paginate_comments_links($args = array()) {
global $wp_rewrite;
- if ( !is_singular() || !get_option('page_comments') )
+ if ( ! is_singular() )
return;
$page = get_query_var('cpage');
@@ -2537,7 +2753,7 @@ function paginate_comments_links($args = array()) {
'add_fragment' => '#comments'
);
if ( $wp_rewrite->using_permalinks() )
- $defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . 'comment-page-%#%', 'commentpaged');
+ $defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . $wp_rewrite->comments_pagination_base . '-%#%', 'commentpaged');
$args = wp_parse_args( $args, $defaults );
$page_links = paginate_links( $args );
@@ -2548,6 +2764,105 @@ function paginate_comments_links($args = array()) {
return $page_links;
}
+/**
+ * Returns navigation to next/previous set of comments when applicable.
+ *
+ * @since 4.4.0
+ *
+ * @param array $args {
+ * Optional. Default comments navigation arguments.
+ *
+ * @type string $prev_text Anchor text to display in the previous comments link. Default 'Older comments'.
+ * @type string $next_text Anchor text to display in the next comments link. Default 'Newer comments'.
+ * @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
+ * }
+ * @return string Markup for comments links.
+ */
+function get_the_comments_navigation( $args = array() ) {
+ $navigation = '';
+
+ // Are there comments to navigate through?
+ if ( get_comment_pages_count() > 1 ) {
+ $args = wp_parse_args( $args, array(
+ 'prev_text' => __( 'Older comments' ),
+ 'next_text' => __( 'Newer comments' ),
+ 'screen_reader_text' => __( 'Comments navigation' ),
+ ) );
+
+ $prev_link = get_previous_comments_link( $args['prev_text'] );
+ $next_link = get_next_comments_link( $args['next_text'] );
+
+ if ( $prev_link ) {
+ $navigation .= '
' . $prev_link . '
';
+ }
+
+ if ( $next_link ) {
+ $navigation .= '
' . $next_link . '
';
+ }
+
+ $navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'] );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Displays navigation to next/previous set of comments when applicable.
+ *
+ * @since 4.4.0
+ *
+ * @param array $args See {@see get_the_comments_navigation()} for available arguments.
+ */
+function the_comments_navigation( $args = array() ) {
+ echo get_the_comments_navigation( $args );
+}
+
+/**
+ * Returns a paginated navigation to next/previous set of comments,
+ * when applicable.
+ *
+ * @since 4.4.0
+ *
+ * @see paginate_comments_links()
+ *
+ * @param array $args {
+ * Optional. Default pagination arguments.
+ *
+ * @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
+ * }
+ * @return string Markup for pagination links.
+ */
+function get_the_comments_pagination( $args = array() ) {
+ $navigation = '';
+ $args = wp_parse_args( $args, array(
+ 'screen_reader_text' => __( 'Comments navigation' ),
+ ) );
+ $args['echo'] = false;
+
+ // Make sure we get plain links, so we get a string we can work with.
+ $args['type'] = 'plain';
+
+ $links = paginate_comments_links( $args );
+
+ if ( $links ) {
+ $navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'] );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Displays a paginated navigation to next/previous set of comments,
+ * when applicable.
+ *
+ * @since 4.4.0
+ *
+ * @param array $args See {@see get_the_comments_pagination()} for available arguments.
+ */
+function the_comments_pagination( $args = array() ) {
+ echo get_the_comments_pagination( $args );
+}
+
/**
* Retrieve the Press This bookmarklet link.
*
@@ -2555,26 +2870,50 @@ function paginate_comments_links($args = array()) {
*
* @since 2.6.0
*
+ * @global bool $is_IE
+ * @global string $wp_version
+ * @global WP_Press_This $wp_press_this
+ *
* @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,
- e=w.getSelection,
- k=d.getSelection,
- x=d.selection,
- s=(e?e():(k)?k():(x?x.createRange().text:0)),
- f='" . admin_url('press-this.php') . "',
- l=d.location,
- e=encodeURIComponent,
- u=f+'?u='+e(l.href)+'&t='+e(d.title)+'&s='+e(s)+'&v=4';
- a=function(){if(!w.open(u,'t','toolbar=0,resizable=1,scrollbars=1,status=1,width=720,height=570'))l.href=u;};
- if (/Firefox/.test(navigator.userAgent)) setTimeout(a, 0); else a();
- void(0)";
-
- $link = str_replace(array("\r", "\n", "\t"), '', $link);
+ global $is_IE, $wp_version;
+
+ include_once( ABSPATH . 'wp-admin/includes/class-wp-press-this.php' );
+ $bookmarklet_version = $GLOBALS['wp_press_this']->version;
+ $link = '';
+
+ if ( $is_IE ) {
+ /**
+ * Return the old/shorter bookmarklet code for MSIE 8 and lower,
+ * since they only support a max length of ~2000 characters for
+ * bookmark[let] URLs, which is way to small for our smarter one.
+ * Do update the version number so users do not get the "upgrade your
+ * bookmarklet" notice when using PT in those browsers.
+ */
+ $ua = $_SERVER['HTTP_USER_AGENT'];
+
+ if ( ! empty( $ua ) && preg_match( '/\bMSIE (\d)/', $ua, $matches ) && (int) $matches[1] <= 8 ) {
+ $url = wp_json_encode( admin_url( 'press-this.php' ) );
+
+ $link = 'javascript:var d=document,w=window,e=w.getSelection,k=d.getSelection,x=d.selection,' .
+ 's=(e?e():(k)?k():(x?x.createRange().text:0)),f=' . $url . ',l=d.location,e=encodeURIComponent,' .
+ 'u=f+"?u="+e(l.href)+"&t="+e(d.title)+"&s="+e(s)+"&v=' . $bookmarklet_version . '";' .
+ 'a=function(){if(!w.open(u,"t","toolbar=0,resizable=1,scrollbars=1,status=1,width=600,height=700"))l.href=u;};' .
+ 'if(/Firefox/.test(navigator.userAgent))setTimeout(a,0);else a();void(0)';
+ }
+ }
+
+ if ( empty( $link ) ) {
+ $src = @file_get_contents( ABSPATH . 'wp-admin/js/bookmarklet.min.js' );
+
+ if ( $src ) {
+ $url = wp_json_encode( admin_url( 'press-this.php' ) . '?v=' . $bookmarklet_version );
+ $link = 'javascript:' . str_replace( 'window.pt_url', $url, $src );
+ }
+ }
+
+ $link = str_replace( array( "\r", "\n", "\t" ), '', $link );
/**
* Filter the Press This bookmarklet link.
@@ -2587,7 +2926,7 @@ function get_shortcut_link() {
}
/**
- * Retrieve the home url for the current site.
+ * Retrieve the URL for the current site where the front end is accessible.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
@@ -2595,17 +2934,17 @@ function get_shortcut_link() {
*
* @since 3.0.0
*
- * @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.
+ * @param string $path Optional. Path relative to the home url. Default empty.
+ * @param string|null $scheme Optional. Scheme to give the home url context. Accepts
+ * 'http', 'https', 'relative', 'rest', or null. Default null.
* @return string Home url link with optional path appended.
-*/
+ */
function home_url( $path = '', $scheme = null ) {
return get_home_url( null, $path, $scheme );
}
/**
- * Retrieve the home url for a given site.
+ * Retrieve the URL for a given site where the front end is accessible.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
@@ -2614,13 +2953,17 @@ function home_url( $path = '', $scheme = null ) {
*
* @since 3.0.0
*
- * @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.
+ * @global string $pagenow
+ *
+ * @param int $blog_id Optional. Site ID. Default null (current site).
+ * @param string $path Optional. Path relative to the home URL. Default empty.
+ * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts
+ * 'http', 'https', 'relative', 'rest', or null. Default null.
* @return string Home URL link with optional path appended.
-*/
+ */
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
+ global $pagenow;
+
$orig_scheme = $scheme;
if ( empty( $blog_id ) || !is_multisite() ) {
@@ -2632,7 +2975,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
}
if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
- if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] )
+ if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $pagenow )
$scheme = 'https';
else
$scheme = parse_url( $url, PHP_URL_SCHEME );
@@ -2650,14 +2993,16 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
*
* @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.
+ * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',
+ * 'relative', 'rest', or null.
+ * @param int|null $blog_id Site ID, or null for the current site.
*/
return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
}
/**
- * Retrieve the site url for the current site.
+ * Retrieve the URL for the current site where WordPress application files
+ * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
*
* 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
@@ -2665,16 +3010,17 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
*
* @since 3.0.0
*
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path Optional. Path relative to the site url.
* @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 );
}
/**
- * Retrieve the site url for a given site.
+ * Retrieve the URL for a given site where WordPress application files
+ * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
*
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
@@ -2682,13 +3028,13 @@ function site_url( $path = '', $scheme = null ) {
*
* @since 3.0.0
*
- * @param int $blog_id Optional. Blog ID. Default null (current site).
+ * @param int $blog_id Optional. Site 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 ) {
if ( empty( $blog_id ) || !is_multisite() ) {
$url = get_option( 'siteurl' );
@@ -2712,7 +3058,7 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
* @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.
+ * @param int|null $blog_id Site ID, or null for the current site.
*/
return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
}
@@ -2722,10 +3068,10 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
*
* @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.
-*/
+ */
function admin_url( $path = '', $scheme = 'admin' ) {
return get_admin_url( null, $path, $scheme );
}
@@ -2735,13 +3081,13 @@ function admin_url( $path = '', $scheme = 'admin' ) {
*
* @since 3.0.0
*
- * @param int $blog_id Optional. Blog ID. Default null (current site).
+ * @param int $blog_id Optional. Site 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);
@@ -2755,7 +3101,7 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
*
* @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.
+ * @param int|null $blog_id Site ID, or null for the current site.
*/
return apply_filters( 'admin_url', $url, $path, $blog_id );
}
@@ -2765,10 +3111,10 @@ function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
*
* @since 2.6.0
*
- * @param string $path Optional. Path relative to the includes url.
+ * @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 = '', $scheme = null ) {
$url = site_url( '/' . WPINC . '/', $scheme );
@@ -2794,7 +3140,7 @@ function includes_url( $path = '', $scheme = null ) {
*
* @param string $path Optional. Path relative to the content url.
* @return string Content url link with optional path appended.
-*/
+ */
function content_url($path = '') {
$url = set_url_scheme( WP_CONTENT_URL );
@@ -2826,7 +3172,7 @@ function content_url($path = '') {
* 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 = '' ) {
$path = wp_normalize_path( $path );
@@ -2873,10 +3219,10 @@ function plugins_url( $path = '', $plugin = '' ) {
*
* @since 3.0.0
*
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path Optional. Path relative to the site url.
* @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 ) {
if ( ! is_multisite() )
return site_url($path, $scheme);
@@ -2918,7 +3264,7 @@ function network_site_url( $path = '', $scheme = null ) {
* @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 ) {
if ( ! is_multisite() )
return home_url($path, $scheme);
@@ -2956,10 +3302,10 @@ function network_home_url( $path = '', $scheme = null ) {
*
* @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.
-*/
+ */
function network_admin_url( $path = '', $scheme = 'admin' ) {
if ( ! is_multisite() )
return admin_url( $path, $scheme );
@@ -2986,10 +3332,10 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
*
* @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.
-*/
+ */
function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/user/', $scheme);
@@ -3009,14 +3355,14 @@ function user_admin_url( $path = '', $scheme = 'admin' ) {
}
/**
- * Retrieve the url to the admin area for either the current blog or the network depending on context.
+ * Retrieve the url to the admin area for either the current site or the network depending on context.
*
* @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.
-*/
+ */
function self_admin_url($path = '', $scheme = 'admin') {
if ( is_network_admin() )
return network_admin_url($path, $scheme);
@@ -3027,12 +3373,14 @@ function self_admin_url($path = '', $scheme = 'admin') {
}
/**
- * Set the scheme for a URL
+ * Sets the scheme for a URL.
*
* @since 3.4.0
+ * @since 4.4.0 The 'rest' scheme was added.
*
- * @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'.
+ * @param string $url Absolute url that includes a scheme
+ * @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login',
+ * 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null.
* @return string $url URL with chosen scheme.
*/
function set_url_scheme( $url, $scheme = null ) {
@@ -3063,10 +3411,10 @@ function set_url_scheme( $url, $scheme = null ) {
*
* @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'.
+ * @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|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
+ * 'login_post', 'admin', 'relative', 'rest', 'rpc', or null.
*/
return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );
}
@@ -3076,13 +3424,13 @@ function set_url_scheme( $url, $scheme = null ) {
*
* 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.
+ * primary site is returned.
*
* @since 3.1.0
*
- * @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.
+ * @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 site 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 = 0, $path = '', $scheme = 'admin' ) {
@@ -3157,25 +3505,36 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
* Output rel=canonical for singular queries.
*
* @since 2.9.0
-*/
+ */
function rel_canonical() {
- if ( !is_singular() )
+ if ( ! is_singular() ) {
return;
+ }
- global $wp_the_query;
- if ( !$id = $wp_the_query->get_queried_object_id() )
+ if ( ! $id = get_queried_object_id() ) {
return;
+ }
- $link = get_permalink( $id );
+ $url = get_permalink( $id );
- if ( $page = get_query_var('cpage') )
- $link = get_comments_pagenum_link( $page );
+ $page = get_query_var( 'page' );
+ if ( $page >= 2 ) {
+ if ( '' == get_option( 'permalink_structure' ) ) {
+ $url = add_query_arg( 'page', $page, $url );
+ } else {
+ $url = trailingslashit( $url ) . user_trailingslashit( $page, 'single_paged' );
+ }
+ }
- echo "\n";
+ $cpage = get_query_var( 'cpage' );
+ if ( $cpage ) {
+ $url = get_comments_pagenum_link( $cpage );
+ }
+ echo '\n";
}
/**
- * Return a shortlink for a post, page, attachment, or blog.
+ * Return a shortlink for a post, page, attachment, or a site.
*
* 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.
@@ -3184,9 +3543,12 @@ function rel_canonical() {
*
* @since 3.0.0.
*
- * @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.
+ * @param int $id A post or site id. Default is 0, which means the current post or site.
+ * @param string $context Whether the id is a 'site' 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) {
@@ -3205,13 +3567,13 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
*/
$shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );
- if ( false !== $shortlink )
+ if ( false !== $shortlink ) {
return $shortlink;
+ }
- global $wp_query;
$post_id = 0;
if ( 'query' == $context && is_singular() ) {
- $post_id = $wp_query->get_queried_object_id();
+ $post_id = get_queried_object_id();
$post = get_post( $post_id );
} elseif ( 'post' == $context ) {
$post = get_post( $id );
@@ -3289,10 +3651,10 @@ function wp_shortlink_header() {
*
* @since 3.0.0
*
- * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
- * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
+ * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
+ * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $before Optional HTML to display before the link.
- * @param string $after Optional HTML to display after the link.
+ * @param string $after Optional HTML to display after the link.
*/
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
$post = get_post();
@@ -3322,3 +3684,259 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
echo $before, $link, $after;
}
}
+
+
+/**
+ * Retrieve the avatar URL.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or WP_Comment object.
+ * @param array $args {
+ * Optional. Arguments to return instead of the default arguments.
+ *
+ * @type int $size Height and width of the avatar in pixels. Default 96.
+ * @type string $default URL for the default image or a default type. Accepts '404' (return
+ * a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ * 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ * or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values.
+ * Default null.
+ * @type array $processed_args When the function returns, the value will be the processed/sanitized $args
+ * plus a "found_avatar" guess. Pass as a reference. Default null.
+ * }
+ * @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
+ */
+function get_avatar_url( $id_or_email, $args = null ) {
+ $args = get_avatar_data( $id_or_email, $args );
+ return $args['url'];
+}
+
+/**
+ * Retrieve default data about the avatar.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or WP_Comment object.
+ * @param array $args {
+ * Optional. Arguments to return instead of the default arguments.
+ *
+ * @type int $size Height and width of the avatar image file in pixels. Default 96.
+ * @type int $height Display height of the avatar in pixels. Defaults to $size.
+ * @type int $width Display width of the avatar in pixels. Defaults to $size.
+ * @type string $default URL for the default image or a default type. Accepts '404' (return
+ * a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ * 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ * or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values.
+ * Default null.
+ * @type array $processed_args When the function returns, the value will be the processed/sanitized $args
+ * plus a "found_avatar" guess. Pass as a reference. Default null.
+ * @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
+ * }
+ * @return array $processed_args {
+ * Along with the arguments passed in `$args`, this will contain a couple of extra arguments.
+ *
+ * @type bool $found_avatar True if we were able to find an avatar for this user,
+ * false or not set if we couldn't.
+ * @type string $url The URL of the avatar we found.
+ * }
+ */
+function get_avatar_data( $id_or_email, $args = null ) {
+ $args = wp_parse_args( $args, array(
+ 'size' => 96,
+ 'height' => null,
+ 'width' => null,
+ 'default' => get_option( 'avatar_default', 'mystery' ),
+ 'force_default' => false,
+ 'rating' => get_option( 'avatar_rating' ),
+ 'scheme' => null,
+ 'processed_args' => null, // if used, should be a reference
+ 'extra_attr' => '',
+ ) );
+
+ if ( is_numeric( $args['size'] ) ) {
+ $args['size'] = absint( $args['size'] );
+ if ( ! $args['size'] ) {
+ $args['size'] = 96;
+ }
+ } else {
+ $args['size'] = 96;
+ }
+
+ if ( is_numeric( $args['height'] ) ) {
+ $args['height'] = absint( $args['height'] );
+ if ( ! $args['height'] ) {
+ $args['height'] = $args['size'];
+ }
+ } else {
+ $args['height'] = $args['size'];
+ }
+
+ if ( is_numeric( $args['width'] ) ) {
+ $args['width'] = absint( $args['width'] );
+ if ( ! $args['width'] ) {
+ $args['width'] = $args['size'];
+ }
+ } else {
+ $args['width'] = $args['size'];
+ }
+
+ if ( empty( $args['default'] ) ) {
+ $args['default'] = get_option( 'avatar_default', 'mystery' );
+ }
+
+ switch ( $args['default'] ) {
+ case 'mm' :
+ case 'mystery' :
+ case 'mysteryman' :
+ $args['default'] = 'mm';
+ break;
+ case 'gravatar_default' :
+ $args['default'] = false;
+ break;
+ }
+
+ $args['force_default'] = (bool) $args['force_default'];
+
+ $args['rating'] = strtolower( $args['rating'] );
+
+ $args['found_avatar'] = false;
+
+ /**
+ * Filter whether to retrieve the avatar URL early.
+ *
+ * Passing a non-null value in the 'url' member of the return array will
+ * effectively short circuit get_avatar_data(), passing the value through
+ * the {@see 'get_avatar_data'} filter and returning early.
+ *
+ * @since 4.2.0
+ *
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or WP_Comment object.
+ */
+ $args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
+
+ if ( isset( $args['url'] ) && ! is_null( $args['url'] ) ) {
+ /** This filter is documented in wp-includes/link-template.php */
+ return apply_filters( 'get_avatar_data', $args, $id_or_email );
+ }
+
+ $email_hash = '';
+ $user = $email = false;
+
+ if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
+ $id_or_email = get_comment( $id_or_email );
+ }
+
+ // Process the user identifier.
+ if ( is_numeric( $id_or_email ) ) {
+ $user = get_user_by( 'id', absint( $id_or_email ) );
+ } elseif ( is_string( $id_or_email ) ) {
+ if ( strpos( $id_or_email, '@md5.gravatar.com' ) ) {
+ // md5 hash
+ list( $email_hash ) = explode( '@', $id_or_email );
+ } else {
+ // email address
+ $email = $id_or_email;
+ }
+ } elseif ( $id_or_email instanceof WP_User ) {
+ // User Object
+ $user = $id_or_email;
+ } elseif ( $id_or_email instanceof WP_Post ) {
+ // Post Object
+ $user = get_user_by( 'id', (int) $id_or_email->post_author );
+ } elseif ( $id_or_email instanceof WP_Comment ) {
+ /**
+ * Filter the list of allowed comment types for retrieving avatars.
+ *
+ * @since 3.0.0
+ *
+ * @param array $types An array of content types. Default only contains 'comment'.
+ */
+ $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
+ if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
+ $args['url'] = false;
+ /** This filter is documented in wp-includes/link-template.php */
+ return apply_filters( 'get_avatar_data', $args, $id_or_email );
+ }
+
+ if ( ! empty( $id_or_email->user_id ) ) {
+ $user = get_user_by( 'id', (int) $id_or_email->user_id );
+ }
+ if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
+ $email = $id_or_email->comment_author_email;
+ }
+ }
+
+ if ( ! $email_hash ) {
+ if ( $user ) {
+ $email = $user->user_email;
+ }
+
+ if ( $email ) {
+ $email_hash = md5( strtolower( trim( $email ) ) );
+ }
+ }
+
+ if ( $email_hash ) {
+ $args['found_avatar'] = true;
+ $gravatar_server = hexdec( $email_hash[0] ) % 3;
+ } else {
+ $gravatar_server = rand( 0, 2 );
+ }
+
+ $url_args = array(
+ 's' => $args['size'],
+ 'd' => $args['default'],
+ 'f' => $args['force_default'] ? 'y' : false,
+ 'r' => $args['rating'],
+ );
+
+ if ( is_ssl() ) {
+ $url = 'https://secure.gravatar.com/avatar/' . $email_hash;
+ } else {
+ $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+ }
+
+ $url = add_query_arg(
+ rawurlencode_deep( array_filter( $url_args ) ),
+ set_url_scheme( $url, $args['scheme'] )
+ );
+
+ /**
+ * Filter the avatar URL.
+ *
+ * @since 4.2.0
+ *
+ * @param string $url The URL of the avatar.
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or WP_Comment object.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ */
+ $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
+
+ /**
+ * Filter the avatar data.
+ *
+ * @since 4.2.0
+ *
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or WP_Comment object.
+ */
+ return apply_filters( 'get_avatar_data', $args, $id_or_email );
+}