WordPress.org

Make WordPress Core

Changeset 32606


Ignore:
Timestamp:
05/26/2015 06:43:48 PM (6 years ago)
Author:
wonderboymusic
Message:

Fix doc blocks to link-template.php

See #32444.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/link-template.php

    r32106 r32606  
    3232 *
    3333 * @since 2.2.0
    34  * @uses $wp_rewrite
     34 * @global WP_Rewrite $wp_rewrite
    3535 *
    3636 * @param string $string URL with or without a trailing slash.
     
    5656     *                            'month', 'day', 'paged', 'post_type_archive'.
    5757     */
    58     $string = apply_filters( 'user_trailingslashit', $string, $type_of_url );
    59     return $string;
     58    return apply_filters( 'user_trailingslashit', $string, $type_of_url );
    6059}
    6160
     
    9594 * @param int|WP_Post $id        Optional. Post ID or post object. Default is the current post.
    9695 * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
    97  * @return string|bool The permalink URL or false if post does not exist.
     96 * @return string|false The permalink URL or false if post does not exist.
    9897 */
    9998function get_the_permalink( $id = 0, $leavename = false ) {
     
    108107 * @param int|WP_Post $id        Optional. Post ID or post object. Default current post.
    109108 * @param bool        $leavename Optional. Whether to keep post name or page name. Default false.
    110  * @return string|bool The permalink URL or false if post does not exist.
     109 * @return string|false The permalink URL or false if post does not exist.
    111110 */
    112111function get_permalink( $id = 0, $leavename = false ) {
     
    237236 * @since 3.0.0
    238237 *
    239  * @param int $id Optional. Post ID.
     238 * @global WP_Rewrite $wp_rewrite
     239 *
     240 * @param int $id         Optional. Post ID.
    240241 * @param bool $leavename Optional, defaults to false. Whether to keep post name.
    241  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
    242  * @return string The post permalink.
     242 * @param bool $sample    Optional, defaults to false. Is it a sample permalink.
     243 * @return string|WP_Error The post permalink.
    243244 */
    244245function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
     
    293294 * @since 1.0.0
    294295 *
    295  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
    296  * @param mixed $deprecated Not used.
    297  * @return string
     296 * @param int|WP_Post $post_id    Optional. Post ID or WP_Post object. Default is global $post.
     297 * @param mixed       $deprecated Not used.
     298 * @return string|false
    298299 */
    299300function post_permalink( $post_id = 0, $deprecated = '' ) {
     
    311312 * @since 1.5.0
    312313 *
    313  * @param int|object $post Optional. Post ID or object.
    314  * @param bool $leavename Optional, defaults to false. Whether to keep page name.
    315  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
     314 * @param int|object $post      Optional. Post ID or object.
     315 * @param bool       $leavename Optional, defaults to false. Whether to keep page name.
     316 * @param bool       $sample    Optional, defaults to false. Is it a sample permalink.
    316317 * @return string The page permalink.
    317318 */
     
    344345 * @access private
    345346 *
    346  * @param int|object $post Optional. Post ID or object.
    347  * @param bool $leavename Optional. Leave name.
    348  * @param bool $sample Optional. Sample permalink.
     347 * @global WP_Rewrite $wp_rewrite
     348 *
     349 * @param int|object $post      Optional. Post ID or object.
     350 * @param bool       $leavename Optional. Leave name.
     351 * @param bool       $sample    Optional. Sample permalink.
    349352 * @return string The page permalink.
    350353 */
     
    387390 * @since 2.0.0
    388391 *
    389  * @param int|object $post Optional. Post ID or object.
    390  * @param bool $leavename Optional. Leave name.
     392 * @global WP_Rewrite $wp_rewrite
     393 *
     394 * @param int|object $post      Optional. Post ID or object.
     395 * @param bool       $leavename Optional. Leave name.
    391396 * @return string The attachment permalink.
    392397 */
     
    435440 *
    436441 * @since 1.5.0
     442 *
     443 * @global WP_Rewrite $wp_rewrite
    437444 *
    438445 * @param int|bool $year False for current year or year for permalink.
     
    467474 * @since 1.0.0
    468475 *
    469  * @param bool|int $year False for current year. Integer of year.
     476 * @global WP_Rewrite $wp_rewrite
     477 *
     478 * @param bool|int $year  False for current year. Integer of year.
    470479 * @param bool|int $month False for current month. Integer of month.
    471480 * @return string The permalink for the specified month and year archive.
     
    503512 * @since 1.0.0
    504513 *
    505  * @param bool|int $year False for current year. Integer of year.
     514 * @global WP_Rewrite $wp_rewrite
     515 *
     516 * @param bool|int $year  False for current year. Integer of year.
    506517 * @param bool|int $month False for current month. Integer of month.
    507  * @param bool|int $day False for current day. Integer of day.
     518 * @param bool|int $day   False for current day. Integer of day.
    508519 * @return string The permalink for the specified day, month, and year archive.
    509520 */
     
    546557 *
    547558 * @param string $anchor The link's anchor text.
    548  * @param string $feed Optional, defaults to default feed. Feed type.
     559 * @param string $feed   Optional, defaults to default feed. Feed type.
    549560 */
    550561function the_feed_link( $anchor, $feed = '' ) {
     
    567578 *
    568579 * @since 1.5.0
     580 *
     581 * @global WP_Rewrite $wp_rewrite
    569582 *
    570583 * @param string $feed Optional, defaults to default feed. Feed type.
     
    613626 * @since 2.2.0
    614627 *
    615  * @param int $post_id Optional. Post ID.
    616  * @param string $feed Optional. Feed type.
     628 * @param int    $post_id Optional. Post ID.
     629 * @param string $feed    Optional. Feed type.
    617630 * @return string The permalink for the comments feed for the given post.
    618631 */
     
    664677 *
    665678 * @param string $link_text Descriptive text.
    666  * @param int $post_id Optional post ID. Default to current post.
    667  * @param string $feed Optional. Feed format.
    668  * @return string Link to the comment feed for the current post.
     679 * @param int    $post_id   Optional post ID. Default to current post.
     680 * @param string $feed      Optional. Feed format.
    669681*/
    670682function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
     
    693705 * @since 2.5.0
    694706 *
    695  * @param int $author_id ID of an author.
    696  * @param string $feed Optional. Feed type.
     707 * @param int    $author_id ID of an author.
     708 * @param string $feed      Optional. Feed type.
    697709 * @return string Link to the feed for the author specified by $author_id.
    698710*/
     
    737749 * @since 2.5.0
    738750 *
    739  * @param int $cat_id ID of a category.
    740  * @param string $feed Optional. Feed type.
     751 * @param int    $cat_id ID of a category.
     752 * @param string $feed   Optional. Feed type.
    741753 * @return string Link to the feed for the category specified by $cat_id.
    742754*/
    743 function get_category_feed_link($cat_id, $feed = '') {
    744     return get_term_feed_link($cat_id, 'category', $feed);
     755function get_category_feed_link( $cat_id, $feed = '' ) {
     756    return get_term_feed_link( $cat_id, 'category', $feed );
    745757}
    746758
     
    753765 * @since 3.0.0
    754766 *
    755  * @param int $term_id ID of a category.
     767 * @param int    $term_id ID of a category.
    756768 * @param string $taxonomy Optional. Taxonomy of $term_id
    757  * @param string $feed Optional. Feed type.
    758  * @return string Link to the feed for the term specified by $term_id and $taxonomy.
     769 * @param string $feed     Optional. Feed type.
     770 * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
    759771*/
    760772function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
     
    832844 * @since 2.3.0
    833845 *
    834  * @param int $tag_id Tag ID.
    835  * @param string $feed Optional. Feed type.
     846 * @param int    $tag_id Tag ID.
     847 * @param string $feed   Optional. Feed type.
    836848 * @return string The feed permalink for the given tag.
    837849 */
    838 function get_tag_feed_link($tag_id, $feed = '') {
    839     return get_term_feed_link($tag_id, 'post_tag', $feed);
     850function get_tag_feed_link( $tag_id, $feed = '' ) {
     851    return get_term_feed_link( $tag_id, 'post_tag', $feed );
    840852}
    841853
     
    845857 * @since 2.7.0
    846858 *
    847  * @param int $tag_id Tag ID
     859 * @param int    $tag_id  Tag ID
    848860 * @param string $taxonomy Taxonomy
    849861 * @return string The edit tag link URL for the given tag.
     
    865877 * @since 2.7.0
    866878 *
    867  * @param string $link Optional. Anchor text.
     879 * @param string $link   Optional. Anchor text.
    868880 * @param string $before Optional. Display before edit link.
    869  * @param string $after Optional. Display after edit link.
    870  * @param object $tag Tag object.
    871  * @return string HTML content.
     881 * @param string $after  Optional. Display after edit link.
     882 * @param object $tag    Tag object.
    872883 */
    873884function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
     
    934945 * @since 3.1.0
    935946 *
    936  * @param string $link Optional. Anchor text.
     947 * @param string $link   Optional. Anchor text.
    937948 * @param string $before Optional. Display before edit link.
    938  * @param string $after Optional. Display after edit link.
    939  * @param object $term Term object.
    940  * @return string HTML content.
     949 * @param string $after  Optional. Display after edit link.
     950 * @param object $term   Term object.
     951 * @return string|void HTML content.
    941952 */
    942953function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
     
    976987 *
    977988 * @since  3.0.0
     989 *
     990 * @global WP_Rewrite $wp_rewrite
    978991 *
    979992 * @param string $query Optional. The query string to use. If empty the current query is used.
     
    10151028 * @since 2.5.0
    10161029 *
     1030 * @global WP_Rewrite $wp_rewrite
     1031 *
    10171032 * @param string $search_query Optional. Search query.
    1018  * @param string $feed Optional. Feed type.
     1033 * @param string $feed         Optional. Feed type.
    10191034 * @return string The search results feed permalink.
    10201035 */
     
    10441059     * @param string $type The search type. One of 'posts' or 'comments'.
    10451060     */
    1046     $link = apply_filters( 'search_feed_link', $link, $feed, 'posts' );
    1047 
    1048     return $link;
     1061    return apply_filters( 'search_feed_link', $link, $feed, 'posts' );
    10491062}
    10501063
     
    10541067 * @since 2.5.0
    10551068 *
     1069 * @global WP_Rewrite $wp_rewrite
     1070 *
    10561071 * @param string $search_query Optional. Search query.
    1057  * @param string $feed Optional. Feed type.
     1072 * @param string $feed         Optional. Feed type.
    10581073 * @return string The comments feed search results permalink.
    10591074 */
     
    10741089
    10751090    /** This filter is documented in wp-includes/link-template.php */
    1076     $link = apply_filters('search_feed_link', $link, $feed, 'comments');
    1077 
    1078     return $link;
     1091    return apply_filters( 'search_feed_link', $link, $feed, 'comments' );
    10791092}
    10801093
     
    10841097 * @since 3.1.0
    10851098 *
     1099 * @global WP_Rewrite $wp_rewrite
     1100 *
    10861101 * @param string $post_type Post type
    1087  * @return string The post type archive permalink.
     1102 * @return string|false The post type archive permalink.
    10881103 */
    10891104function get_post_type_archive_link( $post_type ) {
     
    11231138 *
    11241139 * @param string $post_type Post type
    1125  * @param string $feed Optional. Feed type
    1126  * @return string The post type feed permalink.
     1140 * @param string $feed      Optional. Feed type
     1141 * @return string|false The post type feed permalink.
    11271142 */
    11281143function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
     
    11631178 * @since 2.3.0
    11641179 *
    1165  * @param int $id Optional. Post ID.
     1180 * @param int    $id      Optional. Post ID.
    11661181 * @param string $context Optional, defaults to display. How to write the '&', defaults to '&'.
    1167  * @return string The edit post link for the given post.
     1182 * @return string|void The edit post link for the given post.
    11681183 */
    11691184function get_edit_post_link( $id = 0, $context = 'display' ) {
     
    12031218 * @since 1.0.0
    12041219 *
    1205  * @param string $text Optional. Anchor text.
     1220 * @param string $text   Optional. Anchor text.
    12061221 * @param string $before Optional. Display before edit link.
    1207  * @param string $after Optional. Display after edit link.
    1208  * @param int $id Optional. Post ID.
     1222 * @param string $after  Optional. Display after edit link.
     1223 * @param int    $id    Optional. Post ID.
    12091224 */
    12101225function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
     
    12421257 * @since 2.9.0
    12431258 *
    1244  * @param int $id Optional. Post ID.
    1245  * @param string $deprecated Not used.
    1246  * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
    1247  * @return string The delete post link URL for the given post.
     1259 * @param int    $id          Optional. Post ID.
     1260 * @param string $deprecated   Not used.
     1261 * @param bool   $force_delete Whether to bypass trash and force deletion. Default is false.
     1262 * @return string|void The delete post link URL for the given post.
    12481263 */
    12491264function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
     
    12831298 *
    12841299 * @param int $comment_id Optional. Comment ID.
    1285  * @return string The edit comment link URL for the given comment.
     1300 * @return string|void The edit comment link URL for the given comment.
    12861301 */
    12871302function get_edit_comment_link( $comment_id = 0 ) {
     
    13081323 * @since 1.0.0
    13091324 *
    1310  * @param string $text Optional. Anchor text.
     1325 * @global object $comment
     1326 *
     1327 * @param string $text   Optional. Anchor text.
    13111328 * @param string $before Optional. Display before edit link.
    1312  * @param string $after Optional. Display after edit link.
     1329 * @param string $after  Optional. Display after edit link.
    13131330 */
    13141331function edit_comment_link( $text = null, $before = '', $after = '' ) {
     
    13431360 *
    13441361 * @param int|stdClass $link Optional. Bookmark ID.
    1345  * @return string The edit bookmark link URL.
     1362 * @return string|void The edit bookmark link URL.
    13461363 */
    13471364function get_edit_bookmark_link( $link = 0 ) {
     
    13691386 * @since 2.7.0
    13701387 *
    1371  * @param string $link Optional. Anchor text.
    1372  * @param string $before Optional. Display before edit link.
    1373  * @param string $after Optional. Display after edit link.
    1374  * @param int $bookmark Optional. Bookmark ID.
     1388 * @param string $link     Optional. Anchor text.
     1389 * @param string $before   Optional. Display before edit link.
     1390 * @param string $after    Optional. Display after edit link.
     1391 * @param int    $bookmark Optional. Bookmark ID.
    13751392 */
    13761393function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
     
    14421459 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
    14431460 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
    1444  * @return mixed      Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
     1461 * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
    14451462 */
    14461463function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
     
    14561473 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
    14571474 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
    1458  * @return mixed      Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
     1475 * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
    14591476 */
    14601477function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
     
    14681485 *
    14691486 * @since 2.5.0
     1487 *
     1488 * @global wpdb $wpdb
    14701489 *
    14711490 * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term.
     
    14731492 * @param bool         $previous       Optional. Whether to retrieve previous post.
    14741493 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
    1475  * @return mixed      Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
     1494 * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
    14761495 */
    14771496function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
     
    16291648 * @param bool         $previous       Optional. Whether to display link to previous or next post. Default true.
    16301649 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
    1631  * @return string The adjacent post relational link URL.
     1650 * @return string|void The adjacent post relational link URL.
    16321651 */
    16331652function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
     
    17381757 * @param bool         $start          Optional. Whether to retrieve first or last post.
    17391758 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
    1740  * @return mixed Array containing the boundary post object if successful, null otherwise.
     1759 * @return null|array Array containing the boundary post object if successful, null otherwise.
    17411760 */
    17421761function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
     
    19341953 * @since 1.5.0
    19351954 *
    1936  * @param int $pagenum Optional. Page ID.
    1937  * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
    1938 *   Otherwise, prepares the URL with esc_url_raw().
     1955 * @global WP_Rewrite $wp_rewrite
     1956 *
     1957 * @param int  $pagenum Optional. Page ID.
     1958 * @param bool $escape  Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
     1959*                       Otherwise, prepares the URL with esc_url_raw().
    19391960 * @return string The link URL for the given page number.
    19401961 */
     
    20102031 * @since 2.0.10
    20112032 *
     2033 * @global int $paged
     2034 *
    20122035 * @param int $max_page Optional. Max pages.
    2013  * @return string The link URL for next posts page.
     2036 * @return string|void The link URL for next posts page.
    20142037 */
    20152038function get_next_posts_page_link($max_page = 0) {
     
    20302053 * @since 0.71
    20312054 *
    2032  * @param int $max_page Optional. Max pages.
    2033  * @param boolean $echo Optional. Echo or return;
    2034  * @return string The link URL for next posts page if `$echo = false`.
     2055 * @param int     $max_page Optional. Max pages.
     2056 * @param boolean $echo     Optional. Echo or return;
     2057 * @return string|void The link URL for next posts page if `$echo = false`.
    20352058 */
    20362059function next_posts( $max_page = 0, $echo = true ) {
     
    20482071 * @since 2.7.0
    20492072 *
    2050  * @param string $label Content for link text.
    2051  * @param int $max_page Optional. Max pages.
    2052  * @return string|null HTML-formatted next posts page link.
     2073 * @global int      $paged
     2074 * @global WP_Query $wp_query
     2075 *
     2076 * @param string $label    Content for link text.
     2077 * @param int    $max_page Optional. Max pages.
     2078 * @return string|void HTML-formatted next posts page link.
    20532079 */
    20542080function get_next_posts_link( $label = null, $max_page = 0 ) {
     
    20852111 * @since 0.71
    20862112 *
    2087  * @param string $label Content for link text.
    2088  * @param int $max_page Optional. Max pages.
     2113 * @param string $label    Content for link text.
     2114 * @param int    $max_page Optional. Max pages.
    20892115 */
    20902116function next_posts_link( $label = null, $max_page = 0 ) {
     
    21012127 * @since 2.0.10
    21022128 *
    2103  * @return string|null The link for the previous posts page.
     2129 * @global int $paged
     2130 *
     2131 * @return string|void The link for the previous posts page.
    21042132 */
    21052133function get_previous_posts_page_link() {
     
    21202148 *
    21212149 * @param boolean $echo Optional. Echo or return;
    2122  * @return string The previous posts page link if `$echo = false`.
     2150 * @return string|void The previous posts page link if `$echo = false`.
    21232151 */
    21242152function previous_posts( $echo = true ) {
     
    21362164 * @since 2.7.0
    21372165 *
     2166 * @global int $paged
     2167 *
    21382168 * @param string $label Optional. Previous page link text.
    2139  * @return string|null HTML-formatted previous page link.
     2169 * @return string|void HTML-formatted previous page link.
    21402170 */
    21412171function get_previous_posts_link( $label = null ) {
     
    21742204 * @since 2.8.0
    21752205 *
     2206 * @global WP_Query $wp_query
     2207 *
    21762208 * @param string|array $args Optional args.
    21772209 * @return string The posts link navigation.
     
    22132245 * @since 0.71
    22142246 *
    2215  * @param string $sep Optional. Separator for posts navigation links.
     2247 * @param string $sep      Optional. Separator for posts navigation links.
    22162248 * @param string $prelabel Optional. Label for previous pages.
    22172249 * @param string $nxtlabel Optional Label for next pages.
     
    24112443 * @since 2.7.0
    24122444 *
    2413  * @param int $pagenum Optional. Page number.
     2445 * @global WP_Rewrite $wp_rewrite
     2446 *
     2447 * @param int $pagenum  Optional. Page number.
    24142448 * @param int $max_page Optional. The maximum number of comment pages.
    24152449 * @return string The comments page number link URL.
     
    24452479     * @param string $result The comments page number link.
    24462480     */
    2447     $result = apply_filters( 'get_comments_pagenum_link', $result );
    2448 
    2449     return $result;
     2481    return apply_filters( 'get_comments_pagenum_link', $result );
    24502482}
    24512483
     
    24552487 * @since 2.7.1
    24562488 *
    2457  * @param string $label Optional. Label for link text.
    2458  * @param int $max_page Optional. Max page.
    2459  * @return string|null HTML-formatted link for the next page of comments.
     2489 * @global WP_Query $wp_query
     2490 *
     2491 * @param string $label    Optional. Label for link text.
     2492 * @param int    $max_page Optional. Max page.
     2493 * @return string|void HTML-formatted link for the next page of comments.
    24602494 */
    24612495function get_next_comments_link( $label = '', $max_page = 0 ) {
     
    25002534 * @since 2.7.0
    25012535 *
    2502  * @param string $label Optional. Label for link text.
    2503  * @param int $max_page Optional. Max page.
     2536 * @param string $label    Optional. Label for link text.
     2537 * @param int    $max_page Optional. Max page.
    25042538 */
    25052539function next_comments_link( $label = '', $max_page = 0 ) {
     
    25132547 *
    25142548 * @param string $label Optional. Label for comments link text.
    2515  * @return string|null HTML-formatted link for the previous page of comments.
     2549 * @return string|void HTML-formatted link for the previous page of comments.
    25162550 */
    25172551function get_previous_comments_link( $label = '' ) {
     
    25562590 * @since 2.7.0
    25572591 *
     2592 * @global WP_Rewrite $wp_rewrite
     2593 *
    25582594 * @param string|array $args Optional args. See paginate_links().
    2559  * @return string Markup for pagination links.
     2595 * @return string|void Markup for pagination links.
    25602596*/
    25612597function paginate_comments_links($args = array()) {
     
    25962632 * @since 2.6.0
    25972633 *
     2634 * @global bool          $is_IE
     2635 * @global string        $wp_version
     2636 * @global WP_Press_This $wp_press_this
     2637 *
    25982638 * @return string The Press This bookmarklet link URL.
    25992639 */
     
    26752715 * @since 3.0.0
    26762716 *
     2717 * @global string $pagenow
     2718 *
    26772719 * @param  int         $blog_id     Optional. Blog ID. Default null (current blog).
    26782720 * @param  string      $path        Optional. Path relative to the home URL. Default empty.
     
    27262768 * @since 3.0.0
    27272769 *
    2728  * @param string $path Optional. Path relative to the site url.
     2770 * @param string $path   Optional. Path relative to the site url.
    27292771 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    27302772 * @return string Site url link with optional path appended.
     
    27832825 * @since 2.6.0
    27842826 *
    2785  * @param string $path Optional path relative to the admin url.
     2827 * @param string $path   Optional path relative to the admin url.
    27862828 * @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.
    27872829 * @return string Admin url link with optional path appended.
     
    28262868 * @since 2.6.0
    28272869 *
    2828  * @param string $path Optional. Path relative to the includes url.
     2870 * @param string $path   Optional. Path relative to the includes url.
    28292871 * @param string $scheme Optional. Scheme to give the includes url context.
    28302872 * @return string Includes url link with optional path appended.
     
    29342976 * @since 3.0.0
    29352977 *
    2936  * @param string $path Optional. Path relative to the site url.
     2978 * @param string $path   Optional. Path relative to the site url.
    29372979 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    29382980 * @return string Site url link with optional path appended.
     
    30173059 * @since 3.0.0
    30183060 *
    3019  * @param string $path Optional path relative to the admin url.
     3061 * @param string $path   Optional path relative to the admin url.
    30203062 * @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.
    30213063 * @return string Admin url link with optional path appended.
     
    30473089 * @since 3.0.0
    30483090 *
    3049  * @param string $path Optional path relative to the admin url.
     3091 * @param string $path   Optional path relative to the admin url.
    30503092 * @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.
    30513093 * @return string Admin url link with optional path appended.
     
    30743116 * @since 3.1.0
    30753117 *
    3076  * @param string $path Optional path relative to the admin url.
     3118 * @param string $path   Optional path relative to the admin url.
    30773119 * @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.
    30783120 * @return string Admin url link with optional path appended.
     
    30923134 * @since 3.4.0
    30933135 *
    3094  * @param string $url Absolute url that includes a scheme
     3136 * @param string $url    Absolute url that includes a scheme
    30953137 * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
    30963138 * @return string $url URL with chosen scheme.
     
    31413183 * @since 3.1.0
    31423184 *
    3143  * @param int $user_id Optional. User ID. Defaults to current user.
    3144  * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
    3145  * @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.
     3185 * @param int    $user_id Optional. User ID. Defaults to current user.
     3186 * @param string $path    Optional path relative to the dashboard. Use only paths known to both blog and user admins.
     3187 * @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.
    31463188 * @return string Dashboard url link with optional path appended.
    31473189 */
     
    32183260 *
    32193261 * @since 2.9.0
     3262 *
     3263 * @global WP_Query $wp_the_query
    32203264*/
    32213265function rel_canonical() {
     
    32453289 * @since 3.0.0.
    32463290 *
    3247  * @param int $id A post or blog id. Default is 0, which means the current post or blog.
    3248  * @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'.
    3249  * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
     3291 * @global WP_Query $wp_query
     3292 *
     3293 * @param int    $id          A post or blog id. Default is 0, which means the current post or blog.
     3294 * @param string $context     Whether the id is a 'blog' id, 'post' id, or 'media' id.
     3295 *                            If 'post', the post_type of the post is consulted.
     3296 *                            If 'query', the current query is consulted to determine the id and context.
     3297 *                            Default is 'post'.
     3298 * @param bool   $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
    32503299 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
    32513300 */
     
    33503399 * @since 3.0.0
    33513400 *
    3352  * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
    3353  * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
     3401 * @param string $text   Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
     3402 * @param string $title  Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
    33543403 * @param string $before Optional HTML to display before the link.
    3355  * @param string $after Optional HTML to display after the link.
     3404 * @param string $after  Optional HTML to display after the link.
    33563405 */
    33573406function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
Note: See TracChangeset for help on using the changeset viewer.