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 2015-05-26 18:44:25 +00:00
parent 2787e0080a
commit bf16064448
2 changed files with 177 additions and 128 deletions

View File

@ -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
*
* @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.
* @return string|WP_Error The post permalink.
*/
function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
global $wp_rewrite;
@ -294,7 +295,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
*
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
* @param mixed $deprecated Not used.
* @return string
* @return string|false
*/
function post_permalink( $post_id = 0, $deprecated = '' ) {
if ( !empty( $deprecated ) )
@ -343,6 +344,8 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) {
* @since 2.1.0
* @access private
*
* @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.
@ -386,6 +389,8 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) {
*
* @since 2.0.0
*
* @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.
@ -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,6 +473,8 @@ function get_year_link($year) {
*
* @since 1.0.0
*
* @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,6 +511,8 @@ function get_month_link($year, $month) {
*
* @since 1.0.0
*
* @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.
@ -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.
*/
@ -665,7 +678,6 @@ function get_post_comments_feed_link($post_id = 0, $feed = '') {
* @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.
*/
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
$url = esc_url( get_post_comments_feed_link( $post_id, $feed ) );
@ -740,8 +752,8 @@ function get_author_feed_link( $author_id, $feed = '' ) {
* @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 );
}
/**
@ -755,7 +767,7 @@ function get_category_feed_link($cat_id, $feed = '') {
* @param int $term_id ID of a category.
* @param string $taxonomy Optional. Taxonomy of $term_id
* @param string $feed Optional. Feed type.
* @return string Link to the feed for the term specified by $term_id and $taxonomy.
* @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;
@ -835,8 +847,8 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
* @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 );
}
/**
@ -868,7 +880,6 @@ function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
* @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.
*/
function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
$link = edit_term_link( $link, '', '', $tag, false );
@ -937,7 +948,7 @@ function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
* @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.
* @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,6 +1027,8 @@ 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.
* @return string The search results feed permalink.
@ -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,6 +1066,8 @@ 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.
* @return string The comments feed search results permalink.
@ -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;
@ -1123,7 +1138,7 @@ function get_post_type_archive_link( $post_type ) {
*
* @param string $post_type Post type
* @param string $feed Optional. Feed type
* @return string The post type feed permalink.
* @return string|false The post type feed permalink.
*/
function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
$default_feed = get_default_feed();
@ -1164,7 +1179,7 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
*
* @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 ) )
@ -1244,7 +1259,7 @@ function edit_post_link( $text = null, $before = '', $after = '', $id = 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.
* @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,6 +1322,8 @@ 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.
@ -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 );
@ -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,6 +1952,8 @@ function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_te
*
* @since 1.5.0
*
* @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().
@ -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;
@ -2031,7 +2054,7 @@ function get_next_posts_page_link($max_page = 0) {
*
* @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`.
* @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
*
* @global int $paged
* @global WP_Query $wp_query
*
* @param string $label Content for link text.
* @param int $max_page Optional. Max pages.
* @return string|null HTML-formatted next posts page link.
* @return string|void HTML-formatted next posts page link.
*/
function get_next_posts_link( $label = null, $max_page = 0 ) {
global $paged, $wp_query;
@ -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.
*/
@ -2410,6 +2442,8 @@ function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader
*
* @since 2.7.0
*
* @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
*
* @global WP_Query $wp_query
*
* @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.
* @return string|void HTML-formatted link for the next page of comments.
*/
function get_next_comments_link( $label = '', $max_page = 0 ) {
global $wp_query;
@ -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
@ -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,8 +3288,13 @@ function rel_canonical() {
*
* @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. 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 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.
*/

View File

@ -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.