WordPress.org

Make WordPress Core

Changeset 37259


Ignore:
Timestamp:
04/20/2016 02:46:02 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Capitalize URL – an acronym for Uniform Resource Locator – when used in the context of inline docs in wp-includes/link-template.php.

Fixes #30406.

File:
1 edited

Legend:

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

    r37258 r37259  
    29632963 * @since 3.0.0
    29642964 *
    2965  * @param  string      $path   Optional. Path relative to the home url. Default empty.
    2966  * @param  string|null $scheme Optional. Scheme to give the home url context. Accepts
     2965 * @param  string      $path   Optional. Path relative to the home URL. Default empty.
     2966 * @param  string|null $scheme Optional. Scheme to give the home URL context. Accepts
    29672967 *                             'http', 'https', 'relative', 'rest', or null. Default null.
    2968  * @return string Home url link with optional path appended.
     2968 * @return string Home URL link with optional path appended.
    29692969 */
    29702970function home_url( $path = '', $scheme = null ) {
     
    30393039 * @since 3.0.0
    30403040 *
    3041  * @param string $path   Optional. Path relative to the site url. Default empty.
    3042  * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    3043  * @return string Site url link with optional path appended.
     3041 * @param string $path   Optional. Path relative to the site URL. Default empty.
     3042 * @param string $scheme Optional. Scheme to give the site URL context. See set_url_scheme().
     3043 * @return string Site URL link with optional path appended.
    30443044 */
    30453045function site_url( $path = '', $scheme = null ) {
     
    30583058 *
    30593059 * @param int    $blog_id Optional. Site ID. Default null (current site).
    3060  * @param string $path    Optional. Path relative to the site url. Default empty.
    3061  * @param string $scheme  Optional. Scheme to give the site url context. Accepts
     3060 * @param string $path    Optional. Path relative to the site URL. Default empty.
     3061 * @param string $scheme  Optional. Scheme to give the site URL context. Accepts
    30623062 *                        'http', 'https', 'login', 'login_post', 'admin', or
    30633063 *                        'relative'. Default null.
    3064  * @return string Site url link with optional path appended.
     3064 * @return string Site URL link with optional path appended.
    30653065 */
    30663066function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
     
    30973097 * @since 2.6.0
    30983098 *
    3099  * @param string $path   Optional path relative to the admin url.
     3099 * @param string $path   Optional path relative to the admin URL.
    31003100 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
    31013101 *                       'http' or 'https' can be passed to force those schemes.
    3102  * @return string Admin url link with optional path appended.
     3102 * @return string Admin URL link with optional path appended.
    31033103 */
    31043104function admin_url( $path = '', $scheme = 'admin' ) {
     
    31123112 *
    31133113 * @param int    $blog_id Optional. Site ID. Default null (current site).
    3114  * @param string $path    Optional. Path relative to the admin url. Default empty.
     3114 * @param string $path    Optional. Path relative to the admin URL. Default empty.
    31153115 * @param string $scheme  Optional. The scheme to use. Accepts 'http' or 'https',
    31163116 *                        to force those schemes. Default 'admin', which obeys
    31173117 *                        force_ssl_admin() and is_ssl().
    3118  * @return string Admin url link with optional path appended.
     3118 * @return string Admin URL link with optional path appended.
    31193119 */
    31203120function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
     
    31413141 * @since 2.6.0
    31423142 *
    3143  * @param string $path   Optional. Path relative to the includes url. Default empty.
    3144  * @param string $scheme Optional. Scheme to give the includes url context. Accepts
     3143 * @param string $path   Optional. Path relative to the includes URL. Default empty.
     3144 * @param string $scheme Optional. Scheme to give the includes URL context. Accepts
    31453145 *                       'http', 'https', or 'relative'. Default null.
    3146  * @return string Includes url link with optional path appended.
     3146 * @return string Includes URL link with optional path appended.
    31473147 */
    31483148function includes_url( $path = '', $scheme = null ) {
     
    31693169 * @since 2.6.0
    31703170 *
    3171  * @param string $path Optional. Path relative to the content url. Default empty.
    3172  * @return string Content url link with optional path appended.
     3171 * @param string $path Optional. Path relative to the content URL. Default empty.
     3172 * @return string Content URL link with optional path appended.
    31733173 */
    31743174function content_url( $path = '' ) {
     
    32443244 * Retrieves the site URL for the current network.
    32453245 *
    3246  * Returns the site url with the appropriate protocol, 'https' if
     3246 * Returns the site URL with the appropriate protocol, 'https' if
    32473247 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
    32483248 * overridden.
     
    32523252 * @see set_url_scheme()
    32533253 *
    3254  * @param string $path   Optional. Path relative to the site url. Default empty.
    3255  * @param string $scheme Optional. Scheme to give the site url context. Accepts
     3254 * @param string $path   Optional. Path relative to the site URL. Default empty.
     3255 * @param string $scheme Optional. Scheme to give the site URL context. Accepts
    32563256 *                       'http', 'https', or 'relative'. Default null.
    3257  * @return string Site url link with optional path appended.
     3257 * @return string Site URL link with optional path appended.
    32583258 */
    32593259function network_site_url( $path = '', $scheme = null ) {
     
    32883288 * Retrieves the home URL for the current network.
    32893289 *
    3290  * Returns the home url with the appropriate protocol, 'https' is_ssl()
     3290 * Returns the home URL with the appropriate protocol, 'https' is_ssl()
    32913291 * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
    32923292 * overridden.
     
    32943294 * @since 3.0.0
    32953295 *
    3296  * @param  string $path   Optional. Path relative to the home url. Default empty.
    3297  * @param  string $scheme Optional. Scheme to give the home url context. Accepts
     3296 * @param  string $path   Optional. Path relative to the home URL. Default empty.
     3297 * @param  string $scheme Optional. Scheme to give the home URL context. Accepts
    32983298 *                        'http', 'https', or 'relative'. Default null.
    3299  * @return string Home url link with optional path appended.
     3299 * @return string Home URL link with optional path appended.
    33003300 */
    33013301function network_home_url( $path = '', $scheme = null ) {
     
    33363336 * @since 3.0.0
    33373337 *
    3338  * @param string $path   Optional path relative to the admin url. Default empty.
     3338 * @param string $path   Optional path relative to the admin URL. Default empty.
    33393339 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin()
    33403340 *                       and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    3341  * @return string Admin url link with optional path appended.
     3341 * @return string Admin URL link with optional path appended.
    33423342 */
    33433343function network_admin_url( $path = '', $scheme = 'admin' ) {
     
    33673367 * @since 3.0.0
    33683368 *
    3369  * @param string $path   Optional. Path relative to the admin url. Default empty.
     3369 * @param string $path   Optional. Path relative to the admin URL. Default empty.
    33703370 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin()
    33713371 *                       and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    3372  * @return string Admin url link with optional path appended.
     3372 * @return string Admin URL link with optional path appended.
    33733373 */
    33743374function user_admin_url( $path = '', $scheme = 'admin' ) {
     
    33953395 * @since 3.1.0
    33963396 *
    3397  * @param string $path   Optional. Path relative to the admin url. Default empty.
     3397 * @param string $path   Optional. Path relative to the admin URL. Default empty.
    33983398 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin()
    33993399 *                       and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    3400  * @return string Admin url link with optional path appended.
     3400 * @return string Admin URL link with optional path appended.
    34013401 */
    34023402function self_admin_url( $path = '', $scheme = 'admin' ) {
     
    34153415 * @since 4.4.0 The 'rest' scheme was added.
    34163416 *
    3417  * @param string      $url    Absolute url that includes a scheme
     3417 * @param string      $url    Absolute URL that includes a scheme
    34183418 * @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login',
    34193419 *                            'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null.
     
    34703470 * @param string $scheme  The scheme to use. Default is 'admin', which obeys force_ssl_admin()
    34713471 *                        and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    3472  * @return string Dashboard url link with optional path appended.
     3472 * @return string Dashboard URL link with optional path appended.
    34733473 */
    34743474function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
     
    35153515 * @param string $scheme  Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin()
    35163516 *                        and is_ssl(). 'http' or 'https' can be passed to force those schemes.
    3517  * @return string Dashboard url link with optional path appended.
     3517 * @return string Dashboard URL link with optional path appended.
    35183518 */
    35193519function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
Note: See TracChangeset for help on using the changeset viewer.