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

See #31872.

Built from https://develop.svn.wordpress.org/trunk@32344


git-svn-id: http://core.svn.wordpress.org/trunk@32315 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-05-05 00:33:26 +00:00
parent c97c82e481
commit 261e461f9d
2 changed files with 10 additions and 6 deletions

View File

@ -987,13 +987,17 @@ final class WP_Theme implements ArrayAccess {
* Scans a directory for files of a certain extension. * Scans a directory for files of a certain extension.
* *
* @since 3.4.0 * @since 3.4.0
* @static
* @access private * @access private
* *
* @param string $path Absolute path to search. * @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 array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
* @param int $depth How deep to search for files. Optional, defaults to a flat scan (0 depth). -1 depth is infinite. * or null for all extensions. Default null.
* @param string $relative_path The basename of the absolute path. Used to control the returned path * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or
* for the found files, particularly when this function recurses to lower depths. * -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 = '' ) { private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
if ( ! is_dir( $path ) ) if ( ! is_dir( $path ) )

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.3-alpha-32343'; $wp_version = '4.3-alpha-32344';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.