From 98bed37af351b2eaa7e7abbef85ee3a51970058f Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 5 May 2015 00:32:23 +0000 Subject: [PATCH] Properly document `WP_Theme::scandir()` as a static method, adjust parameter documentation for formatting and clarity. See #31872. git-svn-id: https://develop.svn.wordpress.org/trunk@32344 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-theme.php | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/class-wp-theme.php b/src/wp-includes/class-wp-theme.php index b0115aef60..35fd7943e6 100644 --- a/src/wp-includes/class-wp-theme.php +++ b/src/wp-includes/class-wp-theme.php @@ -987,13 +987,17 @@ final class WP_Theme implements ArrayAccess { * Scans a directory for files of a certain extension. * * @since 3.4.0 + * @static * @access private * - * @param string $path Absolute path to search. - * @param mixed Array of extensions to find, string of a single extension, or null for all extensions. - * @param int $depth How deep to search for files. Optional, defaults to a flat scan (0 depth). -1 depth is infinite. - * @param string $relative_path The basename of the absolute path. Used to control the returned path - * for the found files, particularly when this function recurses to lower depths. + * @param string $path Absolute path to search. + * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension, + * or null for all extensions. Default null. + * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or + * -1 (infinite depth). Default 0. + * @param string $relative_path Optional. The basename of the absolute path. Used to control the + * returned path for the found files, particularly when this function + * recurses to lower depths. Default empty. */ private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) { if ( ! is_dir( $path ) )