Make WordPress Core

Changeset 48184


Ignore:
Timestamp:
06/26/2020 06:38:51 PM (6 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock improvements.

See #49572.

Location:
trunk/src
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r48149 r48184  
    10121012                                         * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
    10131013                                         * @param array    $plugin_data An array of plugin data.
    1014                                          * @param string   $status      Status of the plugin. Defaults are 'All', 'Active',
    1015                                          *                              'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
    1016                                          *                              'Drop-ins', 'Search', 'Paused'.
     1014                                         * @param string   $status      Status filter currently applied to the plugin list. Possible
     1015                                         *                              values are: 'all', 'active', 'inactive', 'recently_activated',
     1016                                         *                              'upgrade', 'mustuse', 'dropins', 'search', 'paused',
     1017                                         *                              'auto-update-enabled', 'auto-update-disabled'.
    10171018                                         */
    10181019                                        $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
     
    11321133                 * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    11331134                 * @param array  $plugin_data An array of plugin data.
    1134                  * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
    1135                  *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
    1136                  *                            'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
    1137                  *                            'Auto-updates Disabled'.
     1135                 * @param string $status      Status filter currently applied to the plugin list. Possible
     1136                 *                            values are: 'all', 'active', 'inactive', 'recently_activated',
     1137                 *                            'upgrade', 'mustuse', 'dropins', 'search', 'paused',
     1138                 *                            'auto-update-enabled', 'auto-update-disabled'.
    11381139                 */
    11391140                do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
     
    11501151                 * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    11511152                 * @param array  $plugin_data An array of plugin data.
    1152                  * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
    1153                  *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
    1154                  *                            'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
    1155                  *                            'Auto-updates Disabled'.
     1153                 * @param string $status      Status filter currently applied to the plugin list. Possible
     1154                 *                            values are: 'all', 'active', 'inactive', 'recently_activated',
     1155                 *                            'upgrade', 'mustuse', 'dropins', 'search', 'paused',
     1156                 *                            'auto-update-enabled', 'auto-update-disabled'.
    11561157                 */
    11571158                do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );
  • trunk/src/wp-admin/includes/file.php

    r48164 r48184  
    889889         * @param string[] $file          An array of data for a single file.
    890890         * @param string   $new_file      Filename of the newly-uploaded file.
    891          * @param string   $type          File type.
     891         * @param string   $type          Mime type of the newly-uploaded file.
    892892         */
    893893        $move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
     
    941941         *
    942942         *     @type string $file Filename of the newly-uploaded file.
    943          *     @type string $url  URL of the uploaded file.
    944          *     @type string $type File type.
     943         *     @type string $url  URL of the newly-uploaded file.
     944         *     @type string $type Mime type of the newly-uploaded file.
    945945         * }
    946946         * @param string $context The type of upload action. Values include 'upload' or 'sideload'.
  • trunk/src/wp-includes/canonical.php

    r48182 r48184  
    851851         *
    852852         * Passing a false value to the filter will disable the URL guessing
    853          * and return early.
     853         * and return early without performing a redirect.
    854854         *
    855855         * @since 5.5.0
     
    863863
    864864        /**
    865          * Filters whether to short-circuit redirect URL guessing for 404 requests.
     865         * Short-circuits the redirect URL guessing for 404 requests.
    866866         *
    867867         * Passing a non-null value to the filter will effectively short-circuit
     
    870870         * @since 5.5.0
    871871         *
    872          * @param null|string $pre Whether to short-circuit redirect guess 404 permalink.
    873          *                         Default null to continue with the URL guessing.
     872         * @param null|string|false $pre Whether to short-circuit guessing the redirect for a 404.
     873         *                               Default null to continue with the URL guessing.
    874874         */
    875875        $pre = apply_filters( 'pre_redirect_guess_404_permalink', null );
     
    880880        if ( get_query_var( 'name' ) ) {
    881881                /**
    882                  * Filters whether to perform a strict or loose guess.
     882                 * Filters whether to perform a strict guess for a 404 redirect.
    883883                 *
    884884                 * Passing a truthy value to the filter will redirect only exact post_name matches.
     
    886886                 * @since 5.5.0
    887887                 *
    888                  * @param bool $strict_guess Whether to perform a strict/exact guess. Default false (loose guess).
     888                 * @param bool $strict_guess Whether to perform a strict guess. Default false (loose guess).
    889889                 */
    890890                $strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );
  • trunk/src/wp-includes/class-wp-http-proxy.php

    r48109 r48184  
    161161         * @since 2.8.0
    162162         *
    163          * @param string $uri URI to check.
    164          * @return bool True, to send through the proxy and false if, the proxy should not be used.
     163         * @param string $uri URL of the request.
     164         * @return bool Whether to send the request through the proxy.
    165165         */
    166166        public function send_through_proxy( $uri ) {
     
    182182                 * @since 3.5.0
    183183                 *
    184                  * @param bool|null $override Whether to override the request result. Default null.
    185                  * @param string    $uri      URL to check.
    186                  * @param array     $check    Associative array result of parsing the request URI.
    187                  * @param array     $home     Associative array result of parsing the site URL.
     184                 * @param bool|null $override Whether to send the request through the proxy. Default null.
     185                 * @param string    $uri      URL of the request.
     186                 * @param array     $check    Associative array result of parsing the request URL with `parse_url()`.
     187                 * @param array     $home     Associative array result of parsing the site URL with `parse_url()`.
    188188                 */
    189189                $result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home );
Note: See TracChangeset for help on using the changeset viewer.