Make WordPress Core


Ignore:
Timestamp:
07/23/2020 09:09:04 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Another pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744

File:
1 edited

Legend:

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

    r48115 r48590  
    182182     * @global array $wp_theme_directories
    183183     *
    184      * @param string $theme_dir Directory of the theme within the theme_root.
    185      * @param string $theme_root Theme root.
     184     * @param string        $theme_dir Directory of the theme within the theme_root.
     185     * @param string        $theme_root Theme root.
    186186     * @param WP_Theme|null $_child If this theme is a parent theme, the child may be passed for validation purposes.
    187187     */
     
    682682     * @since 3.4.0
    683683     *
    684      * @param string $key Type of data to store (theme, screenshot, headers, post_templates)
     684     * @param string       $key Type of data to store (theme, screenshot, headers, post_templates)
    685685     * @param array|string $data Data to store
    686686     * @return bool Return value from wp_cache_add()
     
    774774     * @since 3.4.0
    775775     *
    776      * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    777      * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
    778      * @param bool $translate Optional. Whether to translate the header. Defaults to true.
     776     * @param string $header    Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
     777     * @param bool   $markup    Optional. Whether to mark up the header. Defaults to true.
     778     * @param bool   $translate Optional. Whether to translate the header. Defaults to true.
    779779     * @return string|array|false Processed header. An array for Tags if `$markup` is false, string otherwise.
    780780     *                            False on failure.
     
    11601160     * @since 3.4.0
    11611161     *
    1162      * @param string[]|string $type       Optional. Array of extensions to find, string of a single extension,
    1163      *                                    or null for all extensions. Default null.
    1164      * @param int          $depth         Optional. How deep to search for files. Defaults to a flat scan (0 depth).
    1165      *                                    -1 depth is infinite.
    1166      * @param bool         $search_parent Optional. Whether to return parent files. Default false.
     1162     * @param string[]|string $type          Optional. Array of extensions to find, string of a single extension,
     1163     *                                       or null for all extensions. Default null.
     1164     * @param int             $depth         Optional. How deep to search for files. Defaults to a flat scan (0 depth).
     1165     *                                       -1 depth is infinite.
     1166     * @param bool            $search_parent Optional. Whether to return parent files. Default false.
    11671167     * @return string[] Array of files, keyed by the path to the file relative to the theme's directory, with the values
    11681168     *                  being absolute paths.
     
    13881388     * @since 3.4.0
    13891389     *
    1390      * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
    1391      *  settings, or 'both'. Defaults to 'both'.
    1392      * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site.
     1390     * @param string $check   Optional. Whether to check only the 'network'-wide settings, the 'site'
     1391     *                        settings, or 'both'. Defaults to 'both'.
     1392     * @param int    $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site.
    13931393     * @return bool Whether the theme is allowed for the network. Returns true in single-site.
    13941394     */
     
    16371637     * @since 3.4.0
    16381638     *
    1639      * @param string $a First name.
    1640      * @param string $b Second name.
     1639     * @param WP_Theme $a First theme.
     1640     * @param WP_Theme $b Second theme.
    16411641     * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
    16421642     *             Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
     
    16511651     * @since 3.4.0
    16521652     *
    1653      * @param string $a First name.
    1654      * @param string $b Second name.
     1653     * @param WP_Theme $a First theme.
     1654     * @param WP_Theme $b Second theme.
    16551655     * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
    16561656     *             Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
Note: See TracChangeset for help on using the changeset viewer.