WordPress.org

Make WordPress Core

Changeset 37213


Ignore:
Timestamp:
04/15/2016 04:57:15 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Use third-person singular verbs in DocBlock and hook doc summaries in wp-includes/link-template.php.

See #30406.

File:
1 edited

Legend:

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

    r36940 r37213  
    88
    99/**
    10  * Display the permalink for the current post.
     10 * Displays the permalink for the current post.
    1111 *
    1212 * @since 1.2.0
     
    1717function the_permalink( $post = 0 ) {
    1818    /**
    19      * Filter the display of the permalink for the current post.
     19     * Filters the display of the permalink for the current post.
    2020     *
    2121     * @since 1.5.0
     
    2929
    3030/**
    31  * Retrieve trailing slash string, if site is set for adding trailing slashes.
     31 * Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
    3232 *
    3333 * Conditionally adds a trailing slash if the permalink structure has a trailing
     
    3737 *
    3838 * @since 2.2.0
     39 *
    3940 * @global WP_Rewrite $wp_rewrite
    4041 *
     
    5152
    5253    /**
    53      * Filter the trailing slashed string, depending on whether the site is set
    54      * to use training slashes.
     54     * Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes.
    5555     *
    5656     * @since 2.2.0
     
    6565
    6666/**
    67  * Display permalink anchor for current post.
     67 * Displays the permalink anchor for the current post.
    6868 *
    6969 * The permalink mode title will use the post title for the 'a' element 'id'
     
    8989
    9090/**
    91  * Retrieve full permalink for current post or post ID.
     91 * Retrieves the full permalink for the current post or post ID.
    9292 *
    9393 * This function is an alias for get_permalink().
     
    107107
    108108/**
    109  * Retrieve full permalink for current post or post ID.
     109 * Retrieves the full permalink for the current post or post ID.
    110110 *
    111111 * @since 1.0.0
     
    150150
    151151    /**
    152      * Filter the permalink structure for a post before token replacement occurs.
     152     * Filters the permalink structure for a post before token replacement occurs.
    153153     *
    154154     * Only applies to posts with post_type of 'post'.
     
    223223
    224224    /**
    225      * Filter the permalink for a post.
     225     * Filters the permalink for a post.
    226226     *
    227227     * Only applies to posts with post_type of 'post'.
     
    237237
    238238/**
    239  * Retrieve the permalink for a post with a custom post type.
     239 * Retrieves the permalink for a post of a custom post type.
    240240 *
    241241 * @since 3.0.0
     
    282282
    283283    /**
    284      * Filter the permalink for a post with a custom post type.
     284     * Filters the permalink for a post of a custom post type.
    285285     *
    286286     * @since 3.0.0
     
    295295
    296296/**
    297  * Retrieve the permalink for current page or page ID.
     297 * Retrieves the permalink for the current page or page ID.
    298298 *
    299299 * Respects page_on_front. Use this one.
     
    327327
    328328/**
    329  * Retrieve the page permalink.
     329 * Retrieves the page permalink.
    330330 *
    331331 * Ignores page_on_front. Internal use only.
     
    373373
    374374/**
    375  * Retrieve permalink for attachment.
     375 * Retrieves the permalink for an attachment.
    376376 *
    377377 * This can be used in the WordPress Loop or outside of it.
     
    420420
    421421    /**
    422      * Filter the permalink for an attachment.
     422     * Filters the permalink for an attachment.
    423423     *
    424424     * @since 2.0.0
     
    431431
    432432/**
    433  * Retrieve the permalink for the year archives.
     433 * Retrieves the permalink for the year archives.
    434434 *
    435435 * @since 1.5.0
     
    453453
    454454    /**
    455      * Filter the year archive permalink.
     455     * Filters the year archive permalink.
    456456     *
    457457     * @since 1.5.0
     
    464464
    465465/**
    466  * Retrieve the permalink for the month archives with year.
     466 * Retrieves the permalink for the month archives with year.
    467467 *
    468468 * @since 1.0.0
     
    490490
    491491    /**
    492      * Filter the month archive permalink.
     492     * Filters the month archive permalink.
    493493     *
    494494     * @since 1.5.0
     
    502502
    503503/**
    504  * Retrieve the permalink for the day archives with year and month.
     504 * Retrieves the permalink for the day archives with year and month.
    505505 *
    506506 * @since 1.0.0
     
    546546
    547547/**
    548  * Display the permalink for the feed type.
     548 * Displays the permalink for the feed type.
    549549 *
    550550 * @since 3.0.0
     
    557557
    558558    /**
    559      * Filter the feed link anchor tag.
     559     * Filters the feed link anchor tag.
    560560     *
    561561     * @since 3.0.0
     
    569569
    570570/**
    571  * Retrieve the permalink for the feed type.
     571 * Retrieves the permalink for the feed type.
    572572 *
    573573 * @since 1.5.0
     
    605605
    606606    /**
    607      * Filter the feed type permalink.
     607     * Filters the feed type permalink.
    608608     *
    609609     * @since 1.5.0
     
    616616
    617617/**
    618  * Retrieve the permalink for the post comments feed.
     618 * Retrieves the permalink for the post comments feed.
    619619 *
    620620 * @since 2.2.0
     
    665665
    666666    /**
    667      * Filter the post comments feed permalink.
     667     * Filters the post comments feed permalink.
    668668     *
    669669     * @since 1.5.1
     
    675675
    676676/**
    677  * Display the comment feed link for a post.
     677 * Displays the comment feed link for a post.
    678678 *
    679679 * Prints out the comment feed link for a post. Link text is placed in the
     
    695695    $link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>';
    696696    /**
    697      * Filter the post comment feed link anchor tag.
     697     * Filters the post comment feed link anchor tag.
    698698     *
    699699     * @since 2.8.0
     
    707707
    708708/**
    709  * Retrieve the feed link for a given author.
     709 * Retrieves the feed link for a given author.
    710710 *
    711711 * Returns a link to the feed for all posts by a given author. A specific feed
     
    738738
    739739    /**
    740      * Filter the feed link for a given author.
     740     * Filters the feed link for a given author.
    741741     *
    742742     * @since 1.5.1
     
    751751
    752752/**
    753  * Retrieve the feed link for a category.
     753 * Retrieves the feed link for a category.
    754754 *
    755755 * Returns a link to the feed for all posts in a given category. A specific feed
     
    767767
    768768/**
    769  * Retrieve the feed link for a term.
     769 * Retrieves the feed link for a term.
    770770 *
    771771 * Returns a link to the feed for all posts in a given term. A specific feed
     
    849849
    850850/**
    851  * Retrieve permalink for feed of tag.
     851 * Retrieves the permalink for a tag feed.
    852852 *
    853853 * @since 2.3.0
     
    862862
    863863/**
    864  * Retrieve edit tag link.
     864 * Retrieves the edit link for a tag.
    865865 *
    866866 * @since 2.7.0
     
    882882
    883883/**
    884  * Display or retrieve edit tag link with formatting.
     884 * Displays or retrieves the edit link for a tag with formatting.
    885885 *
    886886 * @since 2.7.0
     
    895895
    896896    /**
    897      * Filter the anchor tag for the edit link for a tag (or term in another taxonomy).
     897     * Filters the anchor tag for the edit link for a tag (or term in another taxonomy).
    898898     *
    899899     * @since 2.7.0
     
    945945
    946946    /**
    947      * Filter the edit link for a term.
     947     * Filters the edit link for a term.
    948948     *
    949949     * @since 3.1.0
     
    958958
    959959/**
    960  * Display or retrieve edit term link with formatting.
     960 * Displays or retrieves the edit term link with formatting.
    961961 *
    962962 * @since 3.1.0
     
    986986
    987987    /**
    988      * Filter the anchor tag for the edit link of a term.
     988     * Filters the anchor tag for the edit link of a term.
    989989     *
    990990     * @since 3.1.0
     
    10021002
    10031003/**
    1004  * Retrieve permalink for search.
     1004 * Retrieves the permalink for a search.
    10051005 *
    10061006 * @since  3.0.0
     
    10311031
    10321032    /**
    1033      * Filter the search permalink.
     1033     * Filters the search permalink.
    10341034     *
    10351035     * @since 3.0.0
     
    10421042
    10431043/**
    1044  * Retrieve the permalink for the feed of the search results.
     1044 * Retrieves the permalink for the search results feed.
    10451045 *
    10461046 * @since 2.5.0
     
    10691069
    10701070    /**
    1071      * Filter the search feed link.
     1071     * Filters the search feed link.
    10721072     *
    10731073     * @since 2.5.0
     
    10811081
    10821082/**
    1083  * Retrieve the permalink for the comments feed of the search results.
     1083 * Retrieves the permalink for the search results comments feed.
    10841084 *
    10851085 * @since 2.5.0
     
    11541154
    11551155    /**
    1156      * Filter the post type archive permalink.
     1156     * Filters the post type archive permalink.
    11571157     *
    11581158     * @since 3.1.0
     
    11651165
    11661166/**
    1167  * Retrieve the permalink for a post type archive feed.
     1167 * Retrieves the permalink for a post type archive feed.
    11681168 *
    11691169 * @since 3.1.0
     
    11921192
    11931193    /**
    1194      * Filter the post type archive feed link.
     1194     * Filters the post type archive feed link.
    11951195     *
    11961196     * @since 3.1.0
     
    12031203
    12041204/**
    1205  * Retrieve URL used for the post preview.
     1205 * Retrieves the URL used for the post preview.
    12061206 *
    12071207 * Get the preview post URL. Allows additional query args to be appended.
     
    12311231
    12321232    /**
    1233      * Filter the URL used for a post preview.
     1233     * Filters the URL used for a post preview.
    12341234     *
    12351235     * @since 2.0.5
     
    12431243
    12441244/**
    1245  * Retrieve edit posts link for post.
     1245 * Retrieves the edit post link for post.
    12461246 *
    12471247 * Can be used within the WordPress loop or outside of it. Can be used with
     
    12801280
    12811281    /**
    1282      * Filter the post edit link.
     1282     * Filters the post edit link.
    12831283     *
    12841284     * @since 2.3.0
     
    12931293
    12941294/**
    1295  * Display edit post link for post.
     1295 * Displays the edit post link for post.
    12961296 *
    12971297 * @since 1.0.0
     
    13201320
    13211321    /**
    1322      * Filter the post edit link anchor tag.
     1322     * Filters the post edit link anchor tag.
    13231323     *
    13241324     * @since 2.3.0
     
    13321332
    13331333/**
    1334  * Retrieve delete posts link for post.
     1334 * Retrieves the delete posts link for post.
    13351335 *
    13361336 * Can be used within the WordPress loop or outside of it, with any post type.
     
    13621362
    13631363    /**
    1364      * Filter the post delete link.
     1364     * Filters the post delete link.
    13651365     *
    13661366     * @since 2.9.0
     
    13741374
    13751375/**
    1376  * Retrieve edit comment link.
     1376 * Retrieves the edit comment link.
    13771377 *
    13781378 * @since 2.3.0
     
    14001400
    14011401/**
    1402  * Display edit comment link with formatting.
     1402 * Displays the edit comment link with formatting.
    14031403 *
    14041404 * @since 1.0.0
     
    14221422
    14231423    /**
    1424      * Filter the comment edit link anchor tag.
     1424     * Filters the comment edit link anchor tag.
    14251425     *
    14261426     * @since 2.3.0
     
    14341434
    14351435/**
    1436  * Display edit bookmark link.
     1436 * Displays the edit bookmark link.
    14371437 *
    14381438 * @since 2.7.0
     
    14611461
    14621462/**
    1463  * Display edit bookmark link anchor content.
     1463 * Displays the edit bookmark link anchor content.
    14641464 *
    14651465 * @since 2.7.0
     
    14821482
    14831483    /**
    1484      * Filter the bookmark edit link anchor tag.
     1484     * Filters the bookmark edit link anchor tag.
    14851485     *
    14861486     * @since 2.7.0
     
    14931493
    14941494/**
    1495  * Retrieve edit user link
     1495 * Retrieves the edit user link.
    14961496 *
    14971497 * @since 3.5.0
     
    15311531
    15321532/**
    1533  * Retrieve previous post that is adjacent to current post.
     1533 * Retrieves the previous post that is adjacent to the current post.
    15341534 *
    15351535 * @since 1.5.0
     
    15451545
    15461546/**
    1547  * Retrieve next post that is adjacent to current post.
     1547 * Retrieves the next post that is adjacent to the current post.
    15481548 *
    15491549 * @since 1.5.0
     
    15591559
    15601560/**
    1561  * Retrieve adjacent post.
     1561 * Retrieves the adjacent post.
    15621562 *
    15631563 * Can either be next or previous post.
     
    16171617
    16181618        /**
    1619          * Filter the IDs of terms excluded from adjacent post queries.
     1619         * Filters the IDs of terms excluded from adjacent post queries.
    16201620         *
    16211621         * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    16671667
    16681668    /**
    1669      * Filter the JOIN clause in the SQL for an adjacent post query.
     1669     * Filters the JOIN clause in the SQL for an adjacent post query.
    16701670     *
    16711671     * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    16841684
    16851685    /**
    1686      * Filter the WHERE clause in the SQL for an adjacent post query.
     1686     * Filters the WHERE clause in the SQL for an adjacent post query.
    16871687     *
    16881688     * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    17011701
    17021702    /**
    1703      * Filter the ORDER BY clause in the SQL for an adjacent post query.
     1703     * Filters the ORDER BY clause in the SQL for an adjacent post query.
    17041704     *
    17051705     * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    17361736
    17371737/**
    1738  * Get adjacent post relational link.
     1738 * Retrieves the adjacent post relational link.
    17391739 *
    17401740 * Can either be next or previous post relational link.
     
    17751775
    17761776    /**
    1777      * Filter the adjacent post relational link.
     1777     * Filters the adjacent post relational link.
    17781778     *
    17791779     * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    17881788
    17891789/**
    1790  * Display relational links for the posts adjacent to the current post.
     1790 * Displays the relational links for the posts adjacent to the current post.
    17911791 *
    17921792 * @since 2.8.0
     
    18031803
    18041804/**
    1805  * Display relational links for the posts adjacent to the current post for single post pages.
     1805 * Displays relational links for the posts adjacent to the current post for single post pages.
    18061806 *
    18071807 * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
     
    18171817
    18181818/**
    1819  * Display relational link for the next post adjacent to the current post.
     1819 * Displays the relational link for the next post adjacent to the current post.
    18201820 *
    18211821 * @since 2.8.0
     
    18311831
    18321832/**
    1833  * Display relational link for the previous post adjacent to the current post.
     1833 * Displays the relational link for the previous post adjacent to the current post.
    18341834 *
    18351835 * @since 2.8.0
     
    18451845
    18461846/**
    1847  * Retrieve boundary post.
     1847 * Retrieves the boundary post.
    18481848 *
    18491849 * Boundary being either the first or last post by publish date within the constraints specified
     
    19031903
    19041904/**
    1905  * Get previous post link that is adjacent to the current post.
     1905 * Retrieves the previous post link that is adjacent to the current post.
    19061906 *
    19071907 * @since 3.7.0
     
    19191919
    19201920/**
    1921  * Display previous post link that is adjacent to the current post.
     1921 * Displays the previous post link that is adjacent to the current post.
    19221922 *
    19231923 * @since 1.5.0
     1924 *
    19241925 * @see get_previous_post_link()
    19251926 *
     
    19351936
    19361937/**
    1937  * Get next post link that is adjacent to the current post.
     1938 * Retrieves the next post link that is adjacent to the current post.
    19381939 *
    19391940 * @since 3.7.0
     
    19511952
    19521953/**
    1953  * Display next post link that is adjacent to the current post.
     1954 * Displays the next post link that is adjacent to the current post.
    19541955 *
    19551956 * @since 1.5.0
     
    19671968
    19681969/**
    1969  * Get adjacent post link.
     1970 * Retrieves the adjacent post link.
    19701971 *
    19711972 * Can be either next post link or previous.
     
    20122013
    20132014    /**
    2014      * Filter the adjacent post link.
     2015     * Filters the adjacent post link.
    20152016     *
    20162017     * The dynamic portion of the hook name, `$adjacent`, refers to the type
     
    20302031
    20312032/**
    2032  * Display adjacent post link.
     2033 * Displays the adjacent post link.
    20332034 *
    20342035 * Can be either next post link or previous.
     
    20482049
    20492050/**
    2050  * Retrieve links for page numbers.
     2051 * Retrieves the link for a page number.
    20512052 *
    20522053 * @since 1.5.0
     
    21092110
    21102111    /**
    2111      * Filter the page number link for the current request.
     2112     * Filters the page number link for the current request.
    21122113     *
    21132114     * @since 2.5.0
     
    21242125
    21252126/**
    2126  * Retrieve next posts page link.
     2127 * Retrieves the next posts page link.
    21272128 *
    21282129 * Backported from 2.1.3 to 2.0.10.
     
    21482149
    21492150/**
    2150  * Display or return the next posts page link.
     2151 * Displays or retrieves the next posts page link.
    21512152 *
    21522153 * @since 0.71
     
    21662167
    21672168/**
    2168  * Return the next posts page link.
     2169 * Retrieves the next posts page link.
    21692170 *
    21702171 * @since 2.7.0
     
    22062207
    22072208/**
    2208  * Display the next posts page link.
     2209 * Displays the next posts page link.
    22092210 *
    22102211 * @since 0.71
     
    22182219
    22192220/**
    2220  * Retrieve previous posts page link.
     2221 * Retrieves the previous posts page link.
    22212222 *
    22222223 * Will only return string, if not on a single page or post.
     
    22422243
    22432244/**
    2244  * Display or return the previous posts page link.
     2245 * Displays or retrieves the previous posts page link.
    22452246 *
    22462247 * @since 0.71
     
    22592260
    22602261/**
    2261  * Return the previous posts page link.
     2262 * Retrieves the previous posts page link.
    22622263 *
    22632264 * @since 2.7.0
     
    22882289
    22892290/**
    2290  * Display the previous posts page link.
     2291 * Displays the previous posts page link.
    22912292 *
    22922293 * @since 0.71
     
    22992300
    23002301/**
    2301  * Return post pages link navigation for previous and next pages.
     2302 * Retrieves the post pages link navigation for previous and next pages.
    23022303 *
    23032304 * @since 2.8.0
     
    23402341
    23412342/**
    2342  * Display post pages link navigation for previous and next pages.
     2343 * Displays the post pages link navigation for previous and next pages.
    23432344 *
    23442345 * @since 0.71
     
    23542355
    23552356/**
    2356  * Return navigation to next/previous post when applicable.
     2357 * Retrieves the navigation to next/previous post, when applicable.
    23572358 *
    23582359 * @since 4.1.0
     
    24082409
    24092410/**
    2410  * Display navigation to next/previous post when applicable.
     2411 * Displays the navigation to next/previous post, when applicable.
    24112412 *
    24122413 * @since 4.1.0
     
    24202421
    24212422/**
    2422  * Return navigation to next/previous set of posts when applicable.
     2423 * Returns the navigation to next/previous set of posts, when applicable.
    24232424 *
    24242425 * @since 4.1.0
     
    24672468
    24682469/**
    2469  * Display navigation to next/previous set of posts when applicable.
     2470 * Displays the navigation to next/previous set of posts, when applicable.
    24702471 *
    24712472 * @since 4.1.0
     
    24792480
    24802481/**
    2481  * Return a paginated navigation to next/previous set of posts,
    2482  * when applicable.
     2482 * Retrieves a paginated navigation to next/previous set of posts, when applicable.
    24832483 *
    24842484 * @since 4.1.0
     
    25212521
    25222522/**
    2523  * Display a paginated navigation to next/previous set of posts,
    2524  * when applicable.
     2523 * Displays a paginated navigation to next/previous set of posts, when applicable.
    25252524 *
    25262525 * @since 4.1.0
     
    25562555
    25572556    /**
    2558      * Filter the navigation markup template.
     2557     * Filters the navigation markup template.
    25592558     *
    25602559     * Note: The filtered template HTML must contain specifiers for the navigation
     
    25792578
    25802579/**
    2581  * Retrieve comments page number link.
     2580 * Retrieves the comments page number link.
    25822581 *
    25832582 * @since 2.7.0
     
    26132612
    26142613    /**
    2615      * Filter the comments page number link for the current request.
     2614     * Filters the comments page number link for the current request.
    26162615     *
    26172616     * @since 2.7.0
     
    26232622
    26242623/**
    2625  * Return the link to next comments page.
     2624 * Retrieves the link to the next comments page.
    26262625 *
    26272626 * @since 2.7.1
     
    26602659
    26612660    /**
    2662      * Filter the anchor tag attributes for the next comments page link.
     2661     * Filters the anchor tag attributes for the next comments page link.
    26632662     *
    26642663     * @since 2.7.0
     
    26702669
    26712670/**
    2672  * Display the link to next comments page.
     2671 * Displays the link to the next comments page.
    26732672 *
    26742673 * @since 2.7.0
     
    26822681
    26832682/**
    2684  * Return the previous comments page link.
     2683 * Retrieves the link to the previous comments page.
    26852684 *
    26862685 * @since 2.7.1
     
    27142713
    27152714/**
    2716  * Display the previous comments page link.
     2715 * Displays the link to the previous comments page.
    27172716 *
    27182717 * @since 2.7.0
     
    27252724
    27262725/**
    2727  * Create pagination links for the comments on the current post.
     2726 * Displays or retrieves pagination links for the comments on the current post.
    27282727 *
    27292728 * @see paginate_links()
     
    27662765
    27672766/**
    2768  * Returns navigation to next/previous set of comments when applicable.
     2767 * Retrieves navigation to next/previous set of comments, when applicable.
    27692768 *
    27702769 * @since 4.4.0
     
    28082807
    28092808/**
    2810  * Displays navigation to next/previous set of comments when applicable.
     2809 * Displays navigation to next/previous set of comments, when applicable.
    28112810 *
    28122811 * @since 4.4.0
     
    28192818
    28202819/**
    2821  * Returns a paginated navigation to next/previous set of comments,
    2822  * when applicable.
     2820 * Retrieves a paginated navigation to next/previous set of comments, when applicable.
    28232821 *
    28242822 * @since 4.4.0
     
    28532851
    28542852/**
    2855  * Displays a paginated navigation to next/previous set of comments,
    2856  * when applicable.
     2853 * Displays a paginated navigation to next/previous set of comments, when applicable.
    28572854 *
    28582855 * @since 4.4.0
     
    28652862
    28662863/**
    2867  * Retrieve the Press This bookmarklet link.
    2868  *
    2869  * Use this in 'a' element 'href' attribute.
     2864 * Retrieves the Press This bookmarklet link.
    28702865 *
    28712866 * @since 2.6.0
     
    28852880
    28862881    if ( $is_IE ) {
    2887         /**
     2882        /*
    28882883         * Return the old/shorter bookmarklet code for MSIE 8 and lower,
    28892884         * since they only support a max length of ~2000 characters for
     
    29172912
    29182913    /**
    2919      * Filter the Press This bookmarklet link.
     2914     * Filters the Press This bookmarklet link.
    29202915     *
    29212916     * @since 2.6.0
     
    29272922
    29282923/**
    2929  * Retrieve the URL for the current site where the front end is accessible.
     2924 * Retrieves the URL for the current site where the front end is accessible.
    29302925 *
    29312926 * Returns the 'home' option with the appropriate protocol, 'https' if
     
    29452940
    29462941/**
    2947  * Retrieve the URL for a given site where the front end is accessible.
     2942 * Retrieves the URL for a given site where the front end is accessible.
    29482943 *
    29492944 * Returns the 'home' option with the appropriate protocol, 'https' if
     
    29882983
    29892984    /**
    2990      * Filter the home URL.
     2985     * Filters the home URL.
    29912986     *
    29922987     * @since 3.0.0
     
    30022997
    30032998/**
    3004  * Retrieve the URL for the current site where WordPress application files
     2999 * Retrieves the URL for the current site where WordPress application files
    30053000 * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
    30063001 *
     
    30203015
    30213016/**
    3022  * Retrieve the URL for a given site where WordPress application files
     3017 * Retrieves the URL for a given site where WordPress application files
    30233018 * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
    30243019 *
     
    30513046
    30523047    /**
    3053      * Filter the site URL.
     3048     * Filters the site URL.
    30543049     *
    30553050     * @since 2.7.0
     
    30653060
    30663061/**
    3067  * Retrieve the url to the admin area for the current site.
     3062 * Retrieves the URL to the admin area for the current site.
    30683063 *
    30693064 * @since 2.6.0
     
    30783073
    30793074/**
    3080  * Retrieves the url to the admin area for a given site.
     3075 * Retrieves the URL to the admin area for a given site.
    30813076 *
    30823077 * @since 3.0.0
     
    30963091
    30973092    /**
    3098      * Filter the admin area URL.
     3093     * Filters the admin area URL.
    30993094     *
    31003095     * @since 2.8.0
     
    31083103
    31093104/**
    3110  * Retrieve the url to the includes directory.
     3105 * Retrieves the URL to the includes directory.
    31113106 *
    31123107 * @since 2.6.0
     
    31233118
    31243119    /**
    3125      * Filter the URL to the includes directory.
     3120     * Filters the URL to the includes directory.
    31263121     *
    31273122     * @since 2.8.0
     
    31353130
    31363131/**
    3137  * Retrieve the url to the content directory.
     3132 * Retrieves the URL to the content directory.
    31383133 *
    31393134 * @since 2.6.0
     
    31493144
    31503145    /**
    3151      * Filter the URL to the content directory.
     3146     * Filters the URL to the content directory.
    31523147     *
    31533148     * @since 2.8.0
     
    31613156
    31623157/**
    3163  * Retrieve a URL within the plugins or mu-plugins directory.
     3158 * Retrieves a URL within the plugins or mu-plugins directory.
    31643159 *
    31653160 * Defaults to the plugins directory URL if no arguments are supplied.
     
    31983193
    31993194    /**
    3200      * Filter the URL to the plugins directory.
     3195     * Filters the URL to the plugins directory.
    32013196     *
    32023197     * @since 2.8.0
     
    32123207
    32133208/**
    3214  * Retrieve the site url for the current network.
     3209 * Retrieves the site URL for the current network.
    32153210 *
    32163211 * Returns the site url with the appropriate protocol, 'https' if
     
    32393234
    32403235    /**
    3241      * Filter the network site URL.
     3236     * Filters the network site URL.
    32423237     *
    32433238     * @since 3.0.0
     
    32533248
    32543249/**
    3255  * Retrieves the home url for the current network.
     3250 * Retrieves the home URL for the current network.
    32563251 *
    32573252 * Returns the home url with the appropriate protocol, 'https' {@see is_ssl()}
     
    32853280
    32863281    /**
    3287      * Filter the network home URL.
     3282     * Filters the network home URL.
    32883283     *
    32893284     * @since 3.0.0
     
    32993294
    33003295/**
    3301  * Retrieve the url to the admin area for the network.
     3296 * Retrieves the URL to the admin area for the network.
    33023297 *
    33033298 * @since 3.0.0
     
    33173312
    33183313    /**
    3319      * Filter the network admin URL.
     3314     * Filters the network admin URL.
    33203315     *
    33213316     * @since 3.0.0
     
    33293324
    33303325/**
    3331  * Retrieve the url to the admin area for the current user.
     3326 * Retrieves the URL to the admin area for the current user.
    33323327 *
    33333328 * @since 3.0.0
     
    33443339
    33453340    /**
    3346      * Filter the user admin URL for the current user.
     3341     * Filters the user admin URL for the current user.
    33473342     *
    33483343     * @since 3.1.0
     
    33563351
    33573352/**
    3358  * Retrieve the url to the admin area for either the current site or the network depending on context.
     3353 * Retrieves the URL to the admin area for either the current site or the network depending on context.
    33593354 *
    33603355 * @since 3.1.0
     
    34083403
    34093404    /**
    3410      * Filter the resulting URL after setting the scheme.
     3405     * Filters the resulting URL after setting the scheme.
    34113406     *
    34123407     * @since 3.4.0
     
    34213416
    34223417/**
    3423  * Get the URL to the user's dashboard.
     3418 * Retrieves the URL to the user's dashboard.
    34243419 *
    34253420 * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
     
    34563451
    34573452    /**
    3458      * Filter the dashboard URL for a user.
     3453     * Filters the dashboard URL for a user.
    34593454     *
    34603455     * @since 3.1.0
     
    34703465
    34713466/**
    3472  * Get the URL to the user's profile editor.
     3467 * Retrieves the URL to the user's profile editor.
    34733468 *
    34743469 * @since 3.1.0
     
    34903485
    34913486    /**
    3492      * Filter the URL for a user's profile editor.
     3487     * Filters the URL for a user's profile editor.
    34933488     *
    34943489     * @since 3.1.0
     
    35033498
    35043499/**
    3505  * Output rel=canonical for singular queries.
     3500 * Outputs rel=canonical for singular queries.
    35063501 *
    35073502 * @since 2.9.0
     
    35353530
    35363531/**
    3537  * Return a shortlink for a post, page, attachment, or a site.
     3532 * Returns a shortlink for a post, page, attachment, or site.
    35383533 *
    35393534 * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
     
    35543549function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
    35553550    /**
    3556      * Filter whether to preempt generating a shortlink for the given post.
     3551     * Filters whether to preempt generating a shortlink for the given post.
    35573552     *
    35583553     * Passing a truthy value to the filter will effectively short-circuit the
     
    35963591
    35973592    /**
    3598      * Filter the shortlink for a post.
     3593     * Filters the shortlink for a post.
    35993594     *
    36003595     * @since 3.0.0
     
    36093604
    36103605/**
    3611  *  Inject rel=shortlink into head if a shortlink is defined for the current page.
    3612  *
    3613  *  Attached to the wp_head action.
     3606 * Injects rel=shortlink into the head if a shortlink is defined for the current page.
     3607 *
     3608 * Attached to the wp_head action.
    36143609 *
    36153610 * @since 3.0.0
     
    36253620
    36263621/**
    3627  * Send a Link: rel=shortlink header if a shortlink is defined for the current page.
     3622 * Sends a Link: rel=shortlink header if a shortlink is defined for the current page.
    36283623 *
    36293624 * Attached to the wp action.
     
    36443639
    36453640/**
    3646  * Display the Short Link for a Post
     3641 * Displays the shortlink for a post.
    36473642 *
    36483643 * Must be called from inside "The Loop"
     
    36723667
    36733668        /**
    3674          * Filter the shortlink anchor tag for a post.
     3669         * Filters the short link anchor tag for a post.
    36753670         *
    36763671         * @since 3.0.0
     
    36883683
    36893684/**
    3690  * Retrieve the avatar URL.
     3685 * Retrieves the avatar URL.
    36913686 *
    36923687 * @since 4.2.0
     
    37203715
    37213716/**
    3722  * Retrieve default data about the avatar.
     3717 * Retrieves default data about the avatar.
    37233718 *
    37243719 * @since 4.2.0
     
    38173812
    38183813    /**
    3819      * Filter whether to retrieve the avatar URL early.
     3814     * Filters whether to retrieve the avatar URL early.
    38203815     *
    38213816     * Passing a non-null value in the 'url' member of the return array will
     
    39193914
    39203915    /**
    3921      * Filter the avatar URL.
     3916     * Filters the avatar URL.
    39223917     *
    39233918     * @since 4.2.0
     
    39313926
    39323927    /**
    3933      * Filter the avatar data.
     3928     * Filters the avatar data.
    39343929     *
    39353930     * @since 4.2.0
Note: See TracChangeset for help on using the changeset viewer.