Fix doc blocks to `link-template.php`
See #32444. Built from https://develop.svn.wordpress.org/trunk@32606 git-svn-id: http://core.svn.wordpress.org/trunk@32576 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor
parent
2787e0080a
commit
bf16064448
|
|
@ -31,7 +31,7 @@ function the_permalink() {
|
|||
* blog is not set to have them.
|
||||
*
|
||||
* @since 2.2.0
|
||||
* @uses $wp_rewrite
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $string URL with or without a trailing slash.
|
||||
* @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
|
||||
|
|
@ -55,8 +55,7 @@ function user_trailingslashit($string, $type_of_url = '') {
|
|||
* 'single_feed', 'single_paged', 'feed', 'category', 'page', 'year',
|
||||
* 'month', 'day', 'paged', 'post_type_archive'.
|
||||
*/
|
||||
$string = apply_filters( 'user_trailingslashit', $string, $type_of_url );
|
||||
return $string;
|
||||
return apply_filters( 'user_trailingslashit', $string, $type_of_url );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -94,7 +93,7 @@ function permalink_anchor( $mode = 'id' ) {
|
|||
*
|
||||
* @param int|WP_Post $id Optional. Post ID or post object. Default is the current post.
|
||||
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
|
||||
* @return string|bool The permalink URL or false if post does not exist.
|
||||
* @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 );
|
||||
|
|
@ -107,7 +106,7 @@ function get_the_permalink( $id = 0, $leavename = false ) {
|
|||
*
|
||||
* @param int|WP_Post $id Optional. Post ID or post object. Default current post.
|
||||
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
|
||||
* @return string|bool The permalink URL or false if post does not exist.
|
||||
* @return string|false The permalink URL or false if post does not exist.
|
||||
*/
|
||||
function get_permalink( $id = 0, $leavename = false ) {
|
||||
$rewritecode = array(
|
||||
|
|
@ -236,10 +235,12 @@ function get_permalink( $id = 0, $leavename = false ) {
|
|||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param int $id Optional. Post ID.
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param int $id Optional. Post ID.
|
||||
* @param bool $leavename Optional, defaults to false. Whether to keep post name.
|
||||
* @param bool $sample Optional, defaults to false. Is it a sample permalink.
|
||||
* @return string The post permalink.
|
||||
* @param bool $sample Optional, defaults to false. Is it a sample permalink.
|
||||
* @return string|WP_Error The post permalink.
|
||||
*/
|
||||
function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
|
||||
global $wp_rewrite;
|
||||
|
|
@ -292,9 +293,9 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
|
|||
*
|
||||
* @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
|
||||
* @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 ) )
|
||||
|
|
@ -310,9 +311,9 @@ function post_permalink( $post_id = 0, $deprecated = '' ) {
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional, defaults to false. Whether to keep page name.
|
||||
* @param bool $sample Optional, defaults to false. Is it a sample permalink.
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional, defaults to false. Whether to keep page name.
|
||||
* @param bool $sample Optional, defaults to false. Is it a sample permalink.
|
||||
* @return string The page permalink.
|
||||
*/
|
||||
function get_page_link( $post = false, $leavename = false, $sample = false ) {
|
||||
|
|
@ -343,9 +344,11 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) {
|
|||
* @since 2.1.0
|
||||
* @access private
|
||||
*
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional. Leave name.
|
||||
* @param bool $sample Optional. Sample permalink.
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional. Leave name.
|
||||
* @param bool $sample Optional. Sample permalink.
|
||||
* @return string The page permalink.
|
||||
*/
|
||||
function _get_page_link( $post = false, $leavename = false, $sample = false ) {
|
||||
|
|
@ -386,8 +389,10 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) {
|
|||
*
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional. Leave name.
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param int|object $post Optional. Post ID or object.
|
||||
* @param bool $leavename Optional. Leave name.
|
||||
* @return string The attachment permalink.
|
||||
*/
|
||||
function get_attachment_link( $post = null, $leavename = false ) {
|
||||
|
|
@ -435,6 +440,8 @@ function get_attachment_link( $post = null, $leavename = false ) {
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param int|bool $year False for current year or year for permalink.
|
||||
* @return string The permalink for the specified year archive.
|
||||
*/
|
||||
|
|
@ -466,7 +473,9 @@ function get_year_link($year) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param bool|int $year False for current year. Integer of year.
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param bool|int $year False for current year. Integer of year.
|
||||
* @param bool|int $month False for current month. Integer of month.
|
||||
* @return string The permalink for the specified month and year archive.
|
||||
*/
|
||||
|
|
@ -502,9 +511,11 @@ function get_month_link($year, $month) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param bool|int $year False for current year. Integer of year.
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param bool|int $year False for current year. Integer of year.
|
||||
* @param bool|int $month False for current month. Integer of month.
|
||||
* @param bool|int $day False for current day. Integer of day.
|
||||
* @param bool|int $day False for current day. Integer of day.
|
||||
* @return string The permalink for the specified day, month, and year archive.
|
||||
*/
|
||||
function get_day_link($year, $month, $day) {
|
||||
|
|
@ -545,7 +556,7 @@ function get_day_link($year, $month, $day) {
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param string $anchor The link's anchor text.
|
||||
* @param string $feed Optional, defaults to default feed. Feed type.
|
||||
* @param string $feed Optional, defaults to default feed. Feed type.
|
||||
*/
|
||||
function the_feed_link( $anchor, $feed = '' ) {
|
||||
$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
|
||||
|
|
@ -567,6 +578,8 @@ function the_feed_link( $anchor, $feed = '' ) {
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $feed Optional, defaults to default feed. Feed type.
|
||||
* @return string The feed permalink.
|
||||
*/
|
||||
|
|
@ -612,8 +625,8 @@ function get_feed_link($feed = '') {
|
|||
*
|
||||
* @since 2.2.0
|
||||
*
|
||||
* @param int $post_id Optional. Post ID.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @param int $post_id Optional. Post ID.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @return string The permalink for the comments feed for the given post.
|
||||
*/
|
||||
function get_post_comments_feed_link($post_id = 0, $feed = '') {
|
||||
|
|
@ -663,9 +676,8 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') {
|
|||
* @since 2.5.0
|
||||
*
|
||||
* @param string $link_text Descriptive text.
|
||||
* @param int $post_id Optional post ID. Default to current post.
|
||||
* @param string $feed Optional. Feed format.
|
||||
* @return string Link to the comment feed for the current post.
|
||||
* @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 ) );
|
||||
|
|
@ -692,8 +704,8 @@ function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @param int $author_id ID of an author.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @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 = '' ) {
|
||||
|
|
@ -736,12 +748,12 @@ function get_author_feed_link( $author_id, $feed = '' ) {
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @param int $cat_id ID of a category.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @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);
|
||||
function get_category_feed_link( $cat_id, $feed = '' ) {
|
||||
return get_term_feed_link( $cat_id, 'category', $feed );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -752,10 +764,10 @@ function get_category_feed_link($cat_id, $feed = '') {
|
|||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param int $term_id ID of a category.
|
||||
* @param int $term_id ID of a category.
|
||||
* @param string $taxonomy Optional. Taxonomy of $term_id
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @return string Link to the feed for the term specified by $term_id and $taxonomy.
|
||||
* @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;
|
||||
|
|
@ -831,12 +843,12 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
|
|||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param int $tag_id Tag ID.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @param int $tag_id Tag ID.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @return string The feed permalink for the given tag.
|
||||
*/
|
||||
function get_tag_feed_link($tag_id, $feed = '') {
|
||||
return get_term_feed_link($tag_id, 'post_tag', $feed);
|
||||
function get_tag_feed_link( $tag_id, $feed = '' ) {
|
||||
return get_term_feed_link( $tag_id, 'post_tag', $feed );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -844,7 +856,7 @@ function get_tag_feed_link($tag_id, $feed = '') {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param int $tag_id Tag ID
|
||||
* @param int $tag_id Tag ID
|
||||
* @param string $taxonomy Taxonomy
|
||||
* @return string The edit tag link URL for the given tag.
|
||||
*/
|
||||
|
|
@ -864,11 +876,10 @@ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $before Optional. Display before edit link.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param object $tag Tag object.
|
||||
* @return string HTML content.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param object $tag Tag object.
|
||||
*/
|
||||
function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
|
||||
$link = edit_term_link( $link, '', '', $tag, false );
|
||||
|
|
@ -933,11 +944,11 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
|
|||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $before Optional. Display before edit link.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param object $term Term object.
|
||||
* @return string HTML content.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param object $term Term object.
|
||||
* @return string|void HTML content.
|
||||
*/
|
||||
function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
|
||||
if ( is_null( $term ) )
|
||||
|
|
@ -976,6 +987,8 @@ function edit_term_link( $link = '', $before = '', $after = '', $term = null, $e
|
|||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $query Optional. The query string to use. If empty the current query is used.
|
||||
* @return string The search permalink.
|
||||
*/
|
||||
|
|
@ -1014,8 +1027,10 @@ function get_search_link( $query = '' ) {
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $search_query Optional. Search query.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @return string The search results feed permalink.
|
||||
*/
|
||||
function get_search_feed_link($search_query = '', $feed = '') {
|
||||
|
|
@ -1043,9 +1058,7 @@ function get_search_feed_link($search_query = '', $feed = '') {
|
|||
* @param string $feed Feed type.
|
||||
* @param string $type The search type. One of 'posts' or 'comments'.
|
||||
*/
|
||||
$link = apply_filters( 'search_feed_link', $link, $feed, 'posts' );
|
||||
|
||||
return $link;
|
||||
return apply_filters( 'search_feed_link', $link, $feed, 'posts' );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -1053,8 +1066,10 @@ function get_search_feed_link($search_query = '', $feed = '') {
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $search_query Optional. Search query.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @param string $feed Optional. Feed type.
|
||||
* @return string The comments feed search results permalink.
|
||||
*/
|
||||
function get_search_comments_feed_link($search_query = '', $feed = '') {
|
||||
|
|
@ -1073,9 +1088,7 @@ function get_search_comments_feed_link($search_query = '', $feed = '') {
|
|||
$link = add_query_arg('withcomments', 1, $link);
|
||||
|
||||
/** This filter is documented in wp-includes/link-template.php */
|
||||
$link = apply_filters('search_feed_link', $link, $feed, 'comments');
|
||||
|
||||
return $link;
|
||||
return apply_filters( 'search_feed_link', $link, $feed, 'comments' );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -1083,8 +1096,10 @@ function get_search_comments_feed_link($search_query = '', $feed = '') {
|
|||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string $post_type Post type
|
||||
* @return string The post type archive permalink.
|
||||
* @return string|false The post type archive permalink.
|
||||
*/
|
||||
function get_post_type_archive_link( $post_type ) {
|
||||
global $wp_rewrite;
|
||||
|
|
@ -1122,8 +1137,8 @@ function get_post_type_archive_link( $post_type ) {
|
|||
* @since 3.1.0
|
||||
*
|
||||
* @param string $post_type Post type
|
||||
* @param string $feed Optional. Feed type
|
||||
* @return string The post type feed permalink.
|
||||
* @param string $feed Optional. Feed type
|
||||
* @return string|false The post type feed permalink.
|
||||
*/
|
||||
function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
|
||||
$default_feed = get_default_feed();
|
||||
|
|
@ -1162,9 +1177,9 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
|
|||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param int $id Optional. Post ID.
|
||||
* @param int $id Optional. Post ID.
|
||||
* @param string $context Optional, defaults to display. How to write the '&', defaults to '&'.
|
||||
* @return string The edit post link for the given post.
|
||||
* @return string|void The edit post link for the given post.
|
||||
*/
|
||||
function get_edit_post_link( $id = 0, $context = 'display' ) {
|
||||
if ( ! $post = get_post( $id ) )
|
||||
|
|
@ -1202,10 +1217,10 @@ function get_edit_post_link( $id = 0, $context = 'display' ) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param string $text Optional. Anchor text.
|
||||
* @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 $after Optional. Display after edit link.
|
||||
* @param int $id Optional. Post ID.
|
||||
*/
|
||||
function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
|
||||
if ( ! $post = get_post( $id ) ) {
|
||||
|
|
@ -1241,10 +1256,10 @@ function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
|
|||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param int $id Optional. Post ID.
|
||||
* @param string $deprecated Not used.
|
||||
* @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
|
||||
* @return string The delete post link URL for the given post.
|
||||
* @param int $id Optional. Post ID.
|
||||
* @param string $deprecated Not used.
|
||||
* @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
|
||||
* @return string|void The delete post link URL for the given post.
|
||||
*/
|
||||
function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
|
||||
if ( ! empty( $deprecated ) )
|
||||
|
|
@ -1282,7 +1297,7 @@ function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false
|
|||
* @since 2.3.0
|
||||
*
|
||||
* @param int $comment_id Optional. Comment ID.
|
||||
* @return string The edit comment link URL for the given comment.
|
||||
* @return string|void The edit comment link URL for the given comment.
|
||||
*/
|
||||
function get_edit_comment_link( $comment_id = 0 ) {
|
||||
$comment = get_comment( $comment_id );
|
||||
|
|
@ -1307,9 +1322,11 @@ function get_edit_comment_link( $comment_id = 0 ) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @param string $text Optional. Anchor text.
|
||||
* @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.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
*/
|
||||
function edit_comment_link( $text = null, $before = '', $after = '' ) {
|
||||
global $comment;
|
||||
|
|
@ -1342,7 +1359,7 @@ function edit_comment_link( $text = null, $before = '', $after = '' ) {
|
|||
* @since 2.7.0
|
||||
*
|
||||
* @param int|stdClass $link Optional. Bookmark ID.
|
||||
* @return string The edit bookmark link URL.
|
||||
* @return string|void The edit bookmark link URL.
|
||||
*/
|
||||
function get_edit_bookmark_link( $link = 0 ) {
|
||||
$link = get_bookmark( $link );
|
||||
|
|
@ -1368,10 +1385,10 @@ function get_edit_bookmark_link( $link = 0 ) {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $before Optional. Display before edit link.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param int $bookmark Optional. Bookmark ID.
|
||||
* @param string $link Optional. Anchor text.
|
||||
* @param string $before Optional. Display before edit link.
|
||||
* @param string $after Optional. Display after edit link.
|
||||
* @param int $bookmark Optional. Bookmark ID.
|
||||
*/
|
||||
function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
|
||||
$bookmark = get_bookmark($bookmark);
|
||||
|
|
@ -1441,7 +1458,7 @@ function get_edit_user_link( $user_id = null ) {
|
|||
* @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.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
*/
|
||||
function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
|
||||
|
|
@ -1455,7 +1472,7 @@ function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxono
|
|||
* @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.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
*/
|
||||
function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
|
||||
|
|
@ -1468,11 +1485,13 @@ function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy =
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @global wpdb $wpdb
|
||||
*
|
||||
* @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.
|
||||
* @param bool $previous Optional. Whether to retrieve previous post.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
|
||||
*/
|
||||
function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
|
||||
global $wpdb;
|
||||
|
|
@ -1628,7 +1647,7 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
|
|||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
|
||||
* @param bool $previous Optional. Whether to display link to previous or next post. Default true.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return string The adjacent post relational link URL.
|
||||
* @return string|void The adjacent post relational link URL.
|
||||
*/
|
||||
function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
|
||||
if ( $previous && is_attachment() && $post = get_post() )
|
||||
|
|
@ -1737,7 +1756,7 @@ function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded
|
|||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
|
||||
* @param bool $start Optional. Whether to retrieve first or last post.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return mixed Array containing the boundary post object if successful, null otherwise.
|
||||
* @return null|array Array containing the boundary post object if successful, null otherwise.
|
||||
*/
|
||||
function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
|
||||
$post = get_post();
|
||||
|
|
@ -1933,9 +1952,11 @@ function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_te
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $pagenum Optional. Page ID.
|
||||
* @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
|
||||
* Otherwise, prepares the URL with esc_url_raw().
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param int $pagenum Optional. Page ID.
|
||||
* @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
|
||||
* Otherwise, prepares the URL with esc_url_raw().
|
||||
* @return string The link URL for the given page number.
|
||||
*/
|
||||
function get_pagenum_link($pagenum = 1, $escape = true ) {
|
||||
|
|
@ -2009,8 +2030,10 @@ function get_pagenum_link($pagenum = 1, $escape = true ) {
|
|||
*
|
||||
* @since 2.0.10
|
||||
*
|
||||
* @global int $paged
|
||||
*
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @return string The link URL for next posts page.
|
||||
* @return string|void The link URL for next posts page.
|
||||
*/
|
||||
function get_next_posts_page_link($max_page = 0) {
|
||||
global $paged;
|
||||
|
|
@ -2029,9 +2052,9 @@ function get_next_posts_page_link($max_page = 0) {
|
|||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @param boolean $echo Optional. Echo or return;
|
||||
* @return string The link URL for next posts page if `$echo = false`.
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @param boolean $echo Optional. Echo or return;
|
||||
* @return string|void The link URL for next posts page if `$echo = false`.
|
||||
*/
|
||||
function next_posts( $max_page = 0, $echo = true ) {
|
||||
$output = esc_url( get_next_posts_page_link( $max_page ) );
|
||||
|
|
@ -2047,9 +2070,12 @@ function next_posts( $max_page = 0, $echo = true ) {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $label Content for link text.
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @return string|null HTML-formatted next posts page link.
|
||||
* @global int $paged
|
||||
* @global WP_Query $wp_query
|
||||
*
|
||||
* @param string $label Content for link text.
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @return string|void HTML-formatted next posts page link.
|
||||
*/
|
||||
function get_next_posts_link( $label = null, $max_page = 0 ) {
|
||||
global $paged, $wp_query;
|
||||
|
|
@ -2084,8 +2110,8 @@ function get_next_posts_link( $label = null, $max_page = 0 ) {
|
|||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param string $label Content for link text.
|
||||
* @param int $max_page Optional. Max pages.
|
||||
* @param string $label Content for link text.
|
||||
* @param int $max_page Optional. Max pages.
|
||||
*/
|
||||
function next_posts_link( $label = null, $max_page = 0 ) {
|
||||
echo get_next_posts_link( $label, $max_page );
|
||||
|
|
@ -2100,7 +2126,9 @@ function next_posts_link( $label = null, $max_page = 0 ) {
|
|||
*
|
||||
* @since 2.0.10
|
||||
*
|
||||
* @return string|null The link for the previous posts page.
|
||||
* @global int $paged
|
||||
*
|
||||
* @return string|void The link for the previous posts page.
|
||||
*/
|
||||
function get_previous_posts_page_link() {
|
||||
global $paged;
|
||||
|
|
@ -2119,7 +2147,7 @@ function get_previous_posts_page_link() {
|
|||
* @since 0.71
|
||||
*
|
||||
* @param boolean $echo Optional. Echo or return;
|
||||
* @return string The previous posts page link if `$echo = false`.
|
||||
* @return string|void The previous posts page link if `$echo = false`.
|
||||
*/
|
||||
function previous_posts( $echo = true ) {
|
||||
$output = esc_url( get_previous_posts_page_link() );
|
||||
|
|
@ -2135,8 +2163,10 @@ function previous_posts( $echo = true ) {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @global int $paged
|
||||
*
|
||||
* @param string $label Optional. Previous page link text.
|
||||
* @return string|null HTML-formatted previous page link.
|
||||
* @return string|void HTML-formatted previous page link.
|
||||
*/
|
||||
function get_previous_posts_link( $label = null ) {
|
||||
global $paged;
|
||||
|
|
@ -2173,6 +2203,8 @@ function previous_posts_link( $label = null ) {
|
|||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @global WP_Query $wp_query
|
||||
*
|
||||
* @param string|array $args Optional args.
|
||||
* @return string The posts link navigation.
|
||||
*/
|
||||
|
|
@ -2212,7 +2244,7 @@ function get_posts_nav_link( $args = array() ) {
|
|||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param string $sep Optional. Separator for posts navigation links.
|
||||
* @param string $sep Optional. Separator for posts navigation links.
|
||||
* @param string $prelabel Optional. Label for previous pages.
|
||||
* @param string $nxtlabel Optional Label for next pages.
|
||||
*/
|
||||
|
|
@ -2410,7 +2442,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.
|
||||
*/
|
||||
|
|
@ -2444,9 +2478,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 );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -2454,9 +2486,11 @@ 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;
|
||||
|
|
@ -2499,8 +2533,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 );
|
||||
|
|
@ -2512,7 +2546,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 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') )
|
||||
|
|
@ -2555,8 +2589,10 @@ 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;
|
||||
|
|
@ -2595,6 +2631,10 @@ 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() {
|
||||
|
|
@ -2674,6 +2714,8 @@ function home_url( $path = '', $scheme = null ) {
|
|||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @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
|
||||
|
|
@ -2725,7 +2767,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -2782,7 +2824,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -2825,7 +2867,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -2933,7 +2975,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -3016,7 +3058,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -3046,7 +3088,7 @@ 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.
|
||||
*/
|
||||
|
|
@ -3073,7 +3115,7 @@ function user_admin_url( $path = '', $scheme = 'admin' ) {
|
|||
*
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -3091,7 +3133,7 @@ function self_admin_url($path = '', $scheme = 'admin') {
|
|||
*
|
||||
* @since 3.4.0
|
||||
*
|
||||
* @param string $url Absolute url that includes a scheme
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -3140,9 +3182,9 @@ function set_url_scheme( $url, $scheme = null ) {
|
|||
*
|
||||
* @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 blog and user admins.
|
||||
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
|
||||
* @return string Dashboard url link with optional path appended.
|
||||
*/
|
||||
function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
|
||||
|
|
@ -3217,6 +3259,8 @@ function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
|
|||
* Output rel=canonical for singular queries.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @global WP_Query $wp_the_query
|
||||
*/
|
||||
function rel_canonical() {
|
||||
if ( !is_singular() )
|
||||
|
|
@ -3244,9 +3288,14 @@ 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.
|
||||
* @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.
|
||||
* 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) {
|
||||
|
|
@ -3349,10 +3398,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();
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.3-alpha-32605';
|
||||
$wp_version = '4.3-alpha-32606';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue