Make WordPress Core

Changeset 58385


Ignore:
Timestamp:
06/11/2024 07:12:57 AM (5 weeks ago)
Author:
audrasjb
Message:

Docs: Various docblock improvements in HTTP Request API, as per WP docs standards.

See #60699.

File:
1 edited

Legend:

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

    r58384 r58385  
    2828
    2929/**
    30  * Retrieve the raw response from a safe HTTP request.
     30 * Retrieves the raw response from a safe HTTP request.
    3131 *
    3232 * This function is ideal when the HTTP request is being made to an arbitrary
     
    5454
    5555/**
    56  * Retrieve the raw response from a safe HTTP request using the GET method.
     56 * Retrieves the raw response from a safe HTTP request using the GET method.
    5757 *
    5858 * This function is ideal when the HTTP request is being made to an arbitrary
     
    8080
    8181/**
    82  * Retrieve the raw response from a safe HTTP request using the POST method.
     82 * Retrieves the raw response from a safe HTTP request using the POST method.
    8383 *
    8484 * This function is ideal when the HTTP request is being made to an arbitrary
     
    106106
    107107/**
    108  * Retrieve the raw response from a safe HTTP request using the HEAD method.
     108 * Retrieves the raw response from a safe HTTP request using the HEAD method.
    109109 *
    110110 * This function is ideal when the HTTP request is being made to an arbitrary
     
    222222
    223223/**
    224  * Retrieve only the headers from the raw response.
     224 * Retrieves only the headers from the raw response.
    225225 *
    226226 * @since 2.7.0
     
    242242
    243243/**
    244  * Retrieve a single header by name from the raw response.
     244 * Retrieves a single header by name from the raw response.
    245245 *
    246246 * @since 2.7.0
     
    264264
    265265/**
    266  * Retrieve only the response code from the raw response.
     266 * Retrieves only the response code from the raw response.
    267267 *
    268268 * Will return an empty string if incorrect parameter value is given.
     
    282282
    283283/**
    284  * Retrieve only the response message from the raw response.
     284 * Retrieves only the response message from the raw response.
    285285 *
    286286 * Will return an empty string if incorrect parameter value is given.
     
    300300
    301301/**
    302  * Retrieve only the body from the raw response.
     302 * Retrieves only the body from the raw response.
    303303 *
    304304 * @since 2.7.0
     
    316316
    317317/**
    318  * Retrieve only the cookies from the raw response.
     318 * Retrieves only the cookies from the raw response.
    319319 *
    320320 * @since 4.4.0
     
    333333
    334334/**
    335  * Retrieve a single cookie by name from the raw response.
     335 * Retrieves a single cookie by name from the raw response.
    336336 *
    337337 * @since 4.4.0
     
    359359
    360360/**
    361  * Retrieve a single cookie's value by name from the raw response.
     361 * Retrieves a single cookie's value by name from the raw response.
    362362 *
    363363 * @since 4.4.0
     
    412412
    413413/**
    414  * Get the HTTP Origin of the current request.
     414 * Gets the HTTP Origin of the current request.
    415415 *
    416416 * @since 3.4.0
     
    425425
    426426    /**
    427      * Change the origin of an HTTP request.
     427     * Changes the origin of an HTTP request.
    428428     *
    429429     * @since 3.4.0
     
    435435
    436436/**
    437  * Retrieve list of allowed HTTP origins.
     437 * Retrieves list of allowed HTTP origins.
    438438 *
    439439 * @since 3.4.0
     
    456456
    457457    /**
    458      * Change the origin types allowed for HTTP requests.
     458     * Changes the origin types allowed for HTTP requests.
    459459     *
    460460     * @since 3.4.0
     
    492492
    493493    /**
    494      * Change the allowed HTTP origin result.
     494     * Changes the allowed HTTP origin result.
    495495     *
    496496     * @since 3.4.0
     
    503503
    504504/**
    505  * Send Access-Control-Allow-Origin and related headers if the current request
     505 * Sends Access-Control-Allow-Origin and related headers if the current request
    506506 * is from an allowed origin.
    507507 *
     
    536536
    537537/**
    538  * Validate a URL for safe use in the HTTP API.
     538 * Validates a URL for safe use in the HTTP API.
    539539 *
    540540 * Examples of URLs that are considered unsafe:
     
    600600                // If host appears local, reject unless specifically allowed.
    601601                /**
    602                  * Check if HTTP request is external or not.
     602                 * Checks if HTTP request is external or not.
    603603                 *
    604604                 * Allows to change and allow external requests for the HTTP request.
     
    647647
    648648/**
    649  * Mark allowed redirect hosts safe for HTTP requests as well.
     649 * Marks allowed redirect hosts safe for HTTP requests as well.
    650650 *
    651651 * Attached to the {@see 'http_request_host_is_external'} filter.
     
    748748
    749749/**
    750  * Retrieve a specific component from a parsed URL array.
     750 * Retrieves a specific component from a parsed URL array.
    751751 *
    752752 * @internal
     
    780780
    781781/**
    782  * Translate a PHP_URL_* constant to the named array keys PHP uses.
     782 * Translates a PHP_URL_* constant to the named array keys PHP uses.
    783783 *
    784784 * @internal
Note: See TracChangeset for help on using the changeset viewer.