WordPress.org

Make WordPress Core

Changeset 32344


Ignore:
Timestamp:
05/05/2015 12:32:23 AM (7 years ago)
Author:
DrewAPicture
Message:

Properly document WP_Theme::scandir() as a static method, adjust parameter documentation for formatting and clarity.

See #31872.

File:
1 edited

Legend:

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

    r32170 r32344  
    988988     *
    989989     * @since 3.4.0
    990      * @access private
    991      *
    992      * @param string $path Absolute path to search.
    993      * @param mixed  Array of extensions to find, string of a single extension, or null for all extensions.
    994      * @param int $depth How deep to search for files. Optional, defaults to a flat scan (0 depth). -1 depth is infinite.
    995      * @param string $relative_path The basename of the absolute path. Used to control the returned path
    996      *  for the found files, particularly when this function recurses to lower depths.
     990     * @static
     991     * @access private
     992     *
     993     * @param string            $path          Absolute path to search.
     994     * @param array|string|null $extensions    Optional. Array of extensions to find, string of a single extension,
     995     *                                         or null for all extensions. Default null.
     996     * @param int               $depth         Optional. How many levels deep to search for files. Accepts 0, 1+, or
     997     *                                         -1 (infinite depth). Default 0.
     998     * @param string            $relative_path Optional. The basename of the absolute path. Used to control the
     999     *                                         returned path for the found files, particularly when this function
     1000     *                                         recurses to lower depths. Default empty.
    9971001     */
    9981002    private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
Note: See TracChangeset for help on using the changeset viewer.