WordPress.org

Make WordPress Core


Ignore:
Timestamp:
10/07/2019 07:06:41 PM (21 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous inline docs corrections and improvements.

See #47110

File:
1 edited

Legend:

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

    r45611 r46424  
    155155
    156156/**
    157  * Retrieve the raw response from the HTTP request using the GET method.
     157 * Performs an HTTP request using the GET method and returns its response.
    158158 *
    159159 * @since 2.7.0
     
    172172
    173173/**
    174  * Retrieve the raw response from the HTTP request using the POST method.
     174 * Performs an HTTP request using the POST method and returns its response.
    175175 *
    176176 * @since 2.7.0
     
    189189
    190190/**
    191  * Retrieve the raw response from the HTTP request using the HEAD method.
     191 * Performs an HTTP request using the HEAD method and returns its response.
    192192 *
    193193 * @since 2.7.0
     
    418418 * @since 3.4.0
    419419 *
    420  * @return array Array of origin URLs.
     420 * @return string[] Array of origin URLs.
    421421 */
    422422function get_allowed_http_origins() {
     
    439439     * @since 3.4.0
    440440     *
    441      * @param array $allowed_origins {
    442      *     Default allowed HTTP origins.
    443      *     @type string Non-secure URL for admin origin.
    444      *     @type string Secure URL for admin origin.
    445      *     @type string Non-secure URL for home origin.
    446      *     @type string Secure URL for home origin.
     441     * @param string[] $allowed_origins {
     442     *     Array of default allowed HTTP origins.
     443     *
     444     *     @type string $0 Non-secure URL for admin origin.
     445     *     @type string $1 Secure URL for admin origin.
     446     *     @type string $2 Non-secure URL for home origin.
     447     *     @type string $3 Secure URL for home origin.
    447448     * }
    448449     */
     
    518519 * @since 3.5.2
    519520 *
    520  * @param string $url
     521 * @param string $url Request URL.
    521522 * @return false|string URL or false on failure.
    522523 */
     
    573574                 * @since 3.6.0
    574575                 *
    575                  * @param bool   false Whether HTTP request is external or not.
    576                  * @param string $host IP of the requested host.
    577                  * @param string $url  URL of the requested host.
     576                 * @param bool   $external Whether HTTP request is external or not.
     577                 * @param string $host     Host name of the requested URL.
     578                 * @param string $url      Requested URL.
    578579                 */
    579580                if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) ) {
     
    716717 *
    717718 * @param array|false $url_parts The parsed URL. Can be false if the URL failed to parse.
    718  * @param int    $component The specific component to retrieve. Use one of the PHP
    719  *                          predefined constants to specify which one.
    720  *                          Defaults to -1 (= return all parts as an array).
     719 * @param int         $component The specific component to retrieve. Use one of the PHP
     720 *                               predefined constants to specify which one.
     721 *                               Defaults to -1 (= return all parts as an array).
    721722 * @return mixed False on parse failure; Array of URL components on success;
    722723 *               When a specific component has been requested: null if the component
     
    748749 *
    749750 * @param int $constant PHP_URL_* constant.
    750  * @return string|bool The named key or false.
     751 * @return string|false The named key or false.
    751752 */
    752753function _wp_translate_php_url_constant_to_key( $constant ) {
Note: See TracChangeset for help on using the changeset viewer.