* Display the permalink for the current post.
*
* @since 1.2.0
+ * @since 4.4.0 Added the `$post` parameter.
+ *
+ * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
*/
-function the_permalink() {
+function the_permalink( $post = 0 ) {
/**
* Filter the display of the permalink for the current post.
*
* @since 1.5.0
+ * @since 4.4.0 Added the `$post` parameter.
*
- * @param string $permalink The permalink for the current post.
+ * @param string $permalink The permalink for the current post.
+ * @param int|WP_Post $post Post ID, WP_Post object, or 0. Default 0.
*/
- echo esc_url( apply_filters( 'the_permalink', get_permalink() ) );
+ echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) );
}
/**
- * Retrieve trailing slash string, if blog set for adding trailing slashes.
+ * Retrieve trailing slash string, if site is set for adding trailing slashes.
*
* Conditionally adds a trailing slash if the permalink structure has a trailing
* slash, strips the trailing slash if not. The string is passed through the
* 'user_trailingslashit' filter. Will remove trailing slash from string, if
- * blog is not set to have them.
+ * site is not set to have them.
*
* @since 2.2.0
* @global WP_Rewrite $wp_rewrite
*
* @see get_permalink()
*
- * @param int|WP_Post $id Optional. Post ID or post object. Default is the current post.
+ * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
+ *
* @return string|false The permalink URL or false if post does not exist.
*/
-function get_the_permalink( $id = 0, $leavename = false ) {
- return get_permalink( $id, $leavename );
+function get_the_permalink( $post = 0, $leavename = false ) {
+ return get_permalink( $post, $leavename );
}
/**
*
* @since 1.0.0
*
- * @param int|WP_Post $id Optional. Post ID or post object. Default current post.
+ * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
* @return string|false The permalink URL or false if post does not exist.
*/
-function get_permalink( $id = 0, $leavename = false ) {
+function get_permalink( $post = 0, $leavename = false ) {
$rewritecode = array(
'%year%',
'%monthnum%',
$leavename? '' : '%pagename%',
);
- if ( is_object($id) && isset($id->filter) && 'sample' == $id->filter ) {
- $post = $id;
+ if ( is_object( $post ) && isset( $post->filter ) && 'sample' == $post->filter ) {
$sample = true;
} else {
- $post = get_post($id);
+ $post = get_post( $post );
$sample = false;
}
$slug = $post->post_name;
- $draft_or_pending = isset( $post->post_status ) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ) );
+ $draft_or_pending = get_post_status( $id ) && in_array( get_post_status( $id ), array( 'draft', 'pending', 'auto-draft', 'future' ) );
$post_type = get_post_type_object($post->post_type);
return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample );
}
-/**
- * Retrieve permalink from post ID.
- *
- * @since 1.0.0
- *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
- * @param mixed $deprecated Not used.
- * @return string|false
- */
-function post_permalink( $post_id = 0, $deprecated = '' ) {
- if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '1.3' );
-
- return get_permalink($post_id);
-}
-
/**
* Retrieve the permalink for current page or page ID.
*
$post = get_post( $post );
$parent = ( $post->post_parent > 0 && $post->post_parent != $post->ID ) ? get_post( $post->post_parent ) : false;
+ if ( $parent && ! in_array( $parent->post_type, get_post_types() ) ) {
+ $parent = false;
+ }
if ( $wp_rewrite->using_permalinks() && $parent ) {
if ( 'page' == $parent->post_type )
if ( ! $leavename )
$link = str_replace( '%postname%', $name, $link );
+ } elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) {
+ $link = home_url( user_trailingslashit( $post->post_name ) );
}
if ( ! $link )
if ( empty( $feed ) )
$feed = get_default_feed();
+ $post = get_post( $post_id );
+ $unattached = 'attachment' === $post->post_type && 0 === (int) $post->post_parent;
+
if ( '' != get_option('permalink_structure') ) {
if ( 'page' == get_option('show_on_front') && $post_id == get_option('page_on_front') )
$url = _get_page_link( $post_id );
else
$url = get_permalink($post_id);
- $url = trailingslashit($url) . 'feed';
- if ( $feed != get_default_feed() )
- $url .= "/$feed";
- $url = user_trailingslashit($url, 'single_feed');
+ if ( $unattached ) {
+ $url = home_url( '/feed/' );
+ if ( $feed !== get_default_feed() ) {
+ $url .= "$feed/";
+ }
+ $url = add_query_arg( 'attachment_id', $post_id, $url );
+ } else {
+ $url = trailingslashit($url) . 'feed';
+ if ( $feed != get_default_feed() )
+ $url .= "/$feed";
+ $url = user_trailingslashit($url, 'single_feed');
+ }
} else {
- $type = get_post_field('post_type', $post_id);
- if ( 'page' == $type )
+ if ( $unattached ) {
+ $url = add_query_arg( array( 'feed' => $feed, 'attachment_id' => $post_id ), home_url( '/' ) );
+ } elseif ( 'page' == $post->post_type ) {
$url = add_query_arg( array( 'feed' => $feed, 'page_id' => $post_id ), home_url( '/' ) );
- else
+ } else {
$url = add_query_arg( array( 'feed' => $feed, 'p' => $post_id ), home_url( '/' ) );
+ }
}
/**
* @param string $link_text Descriptive text.
* @param int $post_id Optional post ID. Default to current post.
* @param string $feed Optional. Feed format.
-*/
+ */
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
- $url = esc_url( get_post_comments_feed_link( $post_id, $feed ) );
- if ( empty($link_text) )
+ $url = get_post_comments_feed_link( $post_id, $feed );
+ if ( empty( $link_text ) ) {
$link_text = __('Comments Feed');
+ }
+ $link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>';
/**
* Filter the post comment feed link anchor tag.
*
* @param int $post_id Post ID.
* @param string $feed The feed type, or an empty string for the default feed type.
*/
- echo apply_filters( 'post_comments_feed_link_html', "<a href='$url'>$link_text</a>", $post_id, $feed );
+ echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed );
}
/**
* @param int $author_id ID of an author.
* @param string $feed Optional. Feed type.
* @return string Link to the feed for the author specified by $author_id.
-*/
+ */
function get_author_feed_link( $author_id, $feed = '' ) {
$author_id = (int) $author_id;
$permalink_structure = get_option('permalink_structure');
* @param int $cat_id ID of a category.
* @param string $feed Optional. Feed type.
* @return string Link to the feed for the category specified by $cat_id.
-*/
+ */
function get_category_feed_link( $cat_id, $feed = '' ) {
return get_term_feed_link( $cat_id, 'category', $feed );
}
* @param string $taxonomy Optional. Taxonomy of $term_id
* @param string $feed Optional. Feed type.
* @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
-*/
+ */
function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
$term_id = ( int ) $term_id;
}
/**
- * Retrieve edit term url.
+ * Retrieves the URL for editing a given term.
*
* @since 3.1.0
+ * @since 4.5.0 The `$taxonomy` argument was made optional.
*
* @param int $term_id Term ID.
- * @param string $taxonomy Taxonomy.
- * @param string $object_type The object type. Used to highlight the proper post type menu on the linked page.
+ * @param string $taxonomy Optional. Taxonomy. Defaults to the taxonomy of the term identified by `$term_id`.
+ * @param string $object_type Optional. The object type. Used to highlight the proper post type menu on the linked page.
* Defaults to the first object_type associated with the taxonomy.
* @return string|null The edit term link URL for the given term, or null on failure.
*/
-function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
- $tax = get_taxonomy( $taxonomy );
- if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) {
+function get_edit_term_link( $term_id, $taxonomy = '', $object_type = '' ) {
+ $term = get_term( $term_id, $taxonomy );
+ if ( ! $term || is_wp_error( $term ) ) {
return;
}
- $term = get_term( $term_id, $taxonomy );
- if ( ! $term || is_wp_error( $term ) ) {
+ $tax = get_taxonomy( $term->taxonomy );
+ if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) {
return;
}
$args = array(
- 'action' => 'edit',
'taxonomy' => $taxonomy,
- 'tag_ID' => $term->term_id,
+ 'tag_ID' => $term->term_id,
);
if ( $object_type ) {
$args['post_type'] = reset( $tax->object_type );
}
- $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
+ if ( $tax->show_ui ) {
+ $location = add_query_arg( $args, admin_url( 'term.php' ) );
+ } else {
+ $location = '';
+ }
/**
* Filter the edit link for a term.
$link = home_url('?s=' . urlencode($search) );
} else {
$search = urlencode($search);
- $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it unencoded.
+ $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it un-encoded.
$link = str_replace( '%search%', $search, $permastruct );
$link = home_url( user_trailingslashit( $link, 'search' ) );
}
}
/**
- * Retrieve the permalink for a post type archive.
+ * Retrieves the permalink for a post type archive.
*
* @since 3.1.0
+ * @since 4.5.0 Support for posts was added.
*
* @global WP_Rewrite $wp_rewrite
*
- * @param string $post_type Post type
+ * @param string $post_type Post type.
* @return string|false The post type archive permalink.
*/
function get_post_type_archive_link( $post_type ) {
if ( ! $post_type_obj = get_post_type_object( $post_type ) )
return false;
+ if ( 'post' === $post_type ) {
+ $show_on_front = get_option( 'show_on_front' );
+ $page_for_posts = get_option( 'page_for_posts' );
+
+ if ( 'page' == $show_on_front && $page_for_posts ) {
+ $link = get_permalink( $page_for_posts );
+ } else {
+ $link = get_home_url();
+ }
+ /** This filter is documented in wp-includes/link-template.php */
+ return apply_filters( 'post_type_archive_link', $link, $post_type );
+ }
+
if ( ! $post_type_obj->has_archive )
return false;
return apply_filters( 'post_type_archive_feed_link', $link, $feed );
}
+/**
+ * Retrieve URL used for the post preview.
+ *
+ * Get the preview post URL. Allows additional query args to be appended.
+ *
+ * @since 4.4.0
+ *
+ * @param int|WP_Post $post Optional. Post ID or `WP_Post` object. Defaults to global post.
+ * @param array $query_args Optional. Array of additional query args to be appended to the link.
+ * @param string $preview_link Optional. Base preview link to be used if it should differ from the post permalink.
+ * @return string URL used for the post preview.
+ */
+function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) {
+ $post = get_post( $post );
+ if ( ! $post ) {
+ return;
+ }
+
+ $post_type_object = get_post_type_object( $post->post_type );
+ if ( is_post_type_viewable( $post_type_object ) ) {
+ if ( ! $preview_link ) {
+ $preview_link = set_url_scheme( get_permalink( $post ) );
+ }
+
+ $query_args['preview'] = 'true';
+ $preview_link = add_query_arg( $query_args, $preview_link );
+ }
+
+ /**
+ * Filter the URL used for a post preview.
+ *
+ * @since 2.0.5
+ * @since 4.0.0 Added the `$post` parameter.
+ *
+ * @param string $preview_link URL used for the post preview.
+ * @param WP_Post $post Post object.
+ */
+ return apply_filters( 'preview_post_link', $preview_link, $post );
+}
+
/**
* Retrieve edit posts link for post.
*
*
* @param int $id Optional. Post ID.
* @param string $context Optional, defaults to display. How to write the '&', defaults to '&'.
- * @return string|void The edit post link for the given post.
+ * @return string|null The edit post link for the given post. null if the post type is invalid or does
+ * not allow an editing UI.
*/
function get_edit_post_link( $id = 0, $context = 'display' ) {
if ( ! $post = get_post( $id ) )
if ( !current_user_can( 'edit_post', $post->ID ) )
return;
+ if ( $post_type_object->_edit_link ) {
+ $link = admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) );
+ } else {
+ $link = '';
+ }
+
/**
* Filter the post edit link.
*
* @param string $context The link context. If set to 'display' then ampersands
* are encoded.
*/
- return apply_filters( 'get_edit_post_link', admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ), $post->ID, $context );
+ return apply_filters( 'get_edit_post_link', $link, $post->ID, $context );
}
/**
* Display edit post link for post.
*
* @since 1.0.0
+ * @since 4.4.0 The `$class` argument was added.
*
* @param string $text Optional. Anchor text.
* @param string $before Optional. Display before edit link.
* @param string $after Optional. Display after edit link.
* @param int $id Optional. Post ID.
+ * @param string $class Optional. Add custom class to link.
*/
-function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
+function edit_post_link( $text = null, $before = '', $after = '', $id = 0, $class = 'post-edit-link' ) {
if ( ! $post = get_post( $id ) ) {
return;
}
$text = __( 'Edit This' );
}
- $link = '<a class="post-edit-link" href="' . $url . '">' . $text . '</a>';
+ $link = '<a class="' . esc_attr( $class ) . '" href="' . esc_url( $url ) . '">' . $text . '</a>';
/**
* Filter the post edit link anchor tag.
*
* @since 2.3.0
*
- * @param int $comment_id Optional. Comment ID.
+ * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object.
* @return string|void The edit comment link URL for the given comment.
*/
function get_edit_comment_link( $comment_id = 0 ) {
*
* @since 1.0.0
*
- * @global object $comment
- *
* @param string $text Optional. Anchor text.
* @param string $before Optional. Display before edit link.
* @param string $after Optional. Display after edit link.
*/
function edit_comment_link( $text = null, $before = '', $after = '' ) {
- global $comment;
+ $comment = get_comment();
if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {
return;
$text = __( 'Edit This' );
}
- $link = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '">' . $text . '</a>';
+ $link = '<a class="comment-edit-link" href="' . esc_url( get_edit_comment_link( $comment ) ) . '">' . $text . '</a>';
/**
* Filter the comment edit link anchor tag.
}
/**
- * Display edit bookmark (literally a URL external to blog) link.
+ * Display edit bookmark link.
*
* @since 2.7.0
*
$location = admin_url('link.php?action=edit&link_id=') . $link->link_id;
/**
- * Filter the bookmark (link) edit link.
+ * Filter the bookmark edit link.
*
* @since 2.7.0
*
}
/**
- * Display edit bookmark (literally a URL external to blog) link anchor content.
+ * Display edit bookmark link anchor content.
*
* @since 2.7.0
*
if ( empty($link) )
$link = __('Edit This');
- $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '">' . $link . '</a>';
+ $link = '<a href="' . esc_url( get_edit_bookmark_link( $bookmark ) ) . '">' . $link . '</a>';
/**
* Filter the bookmark edit link anchor tag.
*
* @since 2.5.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
$join = '';
$where = '';
+ $adjacent = $previous ? 'previous' : 'next';
if ( $in_same_term || ! empty( $excluded_terms ) ) {
- $join = " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id";
- $where = $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy );
-
if ( ! empty( $excluded_terms ) && ! is_array( $excluded_terms ) ) {
// back-compat, $excluded_terms used to be $excluded_terms with IDs separated by " and "
if ( false !== strpos( $excluded_terms, ' and ' ) ) {
}
if ( $in_same_term ) {
+ $join .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id";
+ $where .= $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy );
+
if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) )
return '';
$term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );
$where .= " AND tt.term_id IN (" . implode( ',', $term_array ) . ")";
}
+ /**
+ * Filter the IDs of terms excluded from adjacent post queries.
+ *
+ * The dynamic portion of the hook name, `$adjacent`, refers to the type
+ * of adjacency, 'next' or 'previous'.
+ *
+ * @since 4.4.0
+ *
+ * @param string $excluded_terms Array of excluded term IDs.
+ */
+ $excluded_terms = apply_filters( "get_{$adjacent}_post_excluded_terms", $excluded_terms );
+
if ( ! empty( $excluded_terms ) ) {
- $where .= " AND p.ID NOT IN ( SELECT tr.object_id FROM $wpdb->term_relationships tr LEFT JOIN $wpdb->term_taxonomy tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) WHERE tt.term_id IN (" . implode( $excluded_terms, ',' ) . ') )';
+ $where .= " AND p.ID NOT IN ( SELECT tr.object_id FROM $wpdb->term_relationships tr LEFT JOIN $wpdb->term_taxonomy tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) WHERE tt.term_id IN (" . implode( ',', array_map( 'intval', $excluded_terms ) ) . ') )';
}
}
$where .= " AND p.post_status = 'publish'";
}
- $adjacent = $previous ? 'previous' : 'next';
$op = $previous ? '<' : '>';
$order = $previous ? 'DESC' : 'ASC';
* of adjacency, 'next' or 'previous'.
*
* @since 2.5.0
+ * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
*
- * @param string $join The JOIN clause in the SQL.
- * @param bool $in_same_term Whether post should be in a same taxonomy term.
- * @param array $excluded_terms Array of excluded term IDs.
+ * @param string $join The JOIN clause in the SQL.
+ * @param bool $in_same_term Whether post should be in a same taxonomy term.
+ * @param array $excluded_terms Array of excluded term IDs.
+ * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
+ * @param WP_Post $post WP_Post object.
*/
- $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms );
+ $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post );
/**
* Filter the WHERE clause in the SQL for an adjacent post query.
* of adjacency, 'next' or 'previous'.
*
* @since 2.5.0
+ * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
*
* @param string $where The `WHERE` clause in the SQL.
* @param bool $in_same_term Whether post should be in a same taxonomy term.
* @param array $excluded_terms Array of excluded term IDs.
+ * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
+ * @param WP_Post $post WP_Post object.
*/
- $where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms );
+ $where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms, $taxonomy, $post );
/**
* Filter the ORDER BY clause in the SQL for an adjacent post query.
* of adjacency, 'next' or 'previous'.
*
* @since 2.5.0
+ * @since 4.4.0 Added the `$post` parameter.
*
* @param string $order_by The `ORDER BY` clause in the SQL.
+ * @param WP_Post $post WP_Post object.
*/
- $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" );
+ $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1", $post );
$query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort";
$query_key = 'adjacent_post_' . md5( $query );
return get_posts( $query_args );
}
-/*
+/**
* Get previous post link that is adjacent to the current post.
*
* @since 3.7.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().
+ * Otherwise, prepares the URL with esc_url_raw().
* @return string The link URL for the given page number.
*/
function get_pagenum_link($pagenum = 1, $escape = true ) {
* Return navigation to next/previous post when applicable.
*
* @since 4.1.0
+ * @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments.
*
* @param array $args {
* Optional. Default post navigation arguments. Default empty array.
*
- * @type string $prev_text Anchor text to display in the previous post link. Default `%title`.
- * @type string $next_text Anchor text to display in the next post link. Default `%title`.
- * @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
+ * @type string $prev_text Anchor text to display in the previous post link. Default '%title'.
+ * @type string $next_text Anchor text to display in the next post link. Default '%title'.
+ * @type bool $in_same_term Whether link should be in a same taxonomy term. Default false.
+ * @type array|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty.
+ * @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'.
+ * @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
* }
* @return string Markup for post links.
*/
$args = wp_parse_args( $args, array(
'prev_text' => '%title',
'next_text' => '%title',
+ 'in_same_term' => false,
+ 'excluded_terms' => '',
+ 'taxonomy' => 'category',
'screen_reader_text' => __( 'Post navigation' ),
) );
$navigation = '';
- $previous = get_previous_post_link( '<div class="nav-previous">%link</div>', $args['prev_text'] );
- $next = get_next_post_link( '<div class="nav-next">%link</div>', $args['next_text'] );
+
+ $previous = get_previous_post_link(
+ '<div class="nav-previous">%link</div>',
+ $args['prev_text'],
+ $args['in_same_term'],
+ $args['excluded_terms'],
+ $args['taxonomy']
+ );
+
+ $next = get_next_post_link(
+ '<div class="nav-next">%link</div>',
+ $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 ) {
<div class="nav-links">%3$s</div>
</nav>';
+ /**
+ * 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):
+ *
+ * <nav class="navigation %1$s" role="navigation">
+ * <h2 class="screen-reader-text">%2$s</h2>
+ * <div class="nav-links">%3$s</div>
+ * </nav>
+ *
+ * @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 );
}
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');
* @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');
*
* @param string|array $args Optional args. See paginate_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');
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 .= '<div class="nav-previous">' . $prev_link . '</div>';
+ }
+
+ if ( $next_link ) {
+ $navigation .= '<div class="nav-next">' . $next_link . '</div>';
+ }
+
+ $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.
*
}
/**
- * 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',
*
* @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',
*
* @global string $pagenow
*
- * @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.
+ * @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() ) {
}
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 );
*
* @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
* @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',
*
* @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' );
* @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 );
}
* @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 );
}
*
* @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);
*
* @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 );
}
* @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 );
*
* @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 );
* 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 );
* @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);
* @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);
* @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 );
* @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);
}
/**
- * 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 $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);
}
/**
- * 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 ) {
*
* @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 );
}
*
* 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 $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.
*/
* Output rel=canonical for singular queries.
*
* @since 2.9.0
- *
- * @global WP_Query $wp_the_query
-*/
+ */
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 "<link rel='canonical' href='$link' />\n";
+ $cpage = get_query_var( 'cpage' );
+ if ( $cpage ) {
+ $url = get_comments_pagenum_link( $cpage );
+ }
+ echo '<link rel="canonical" href="' . esc_url( $url ) . "\" />\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.
*
* @since 3.0.0.
*
- * @global WP_Query $wp_query
- *
- * @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.
+ * @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'.
*/
$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 );
* @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 comment object.
+ * 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 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 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 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.
*
* @since 4.2.0
*
- * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
- * user email, WP_User object, WP_Post object, or comment object.
+ * @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 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 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 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.
*
* @since 4.2.0
*
- * @param array $args Arguments passed to get_avatar_data(), after processing.
- * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @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 );
$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 ( $id_or_email instanceof WP_Post ) {
// Post Object
$user = get_user_by( 'id', (int) $id_or_email->post_author );
- } elseif ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
- // Comment Object
-
+ } elseif ( $id_or_email instanceof WP_Comment ) {
/**
* Filter the list of allowed comment types for retrieving avatars.
*
*
* @since 4.2.0
*
- * @param string $url The URL of the avatar.
- * @param int|object|string $id_or_email A user ID, email address, or comment object.
- * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @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 );
*
* @since 4.2.0
*
- * @param array $args Arguments passed to get_avatar_data(), after processing.
- * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @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 );
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff