Use the correct hash notation syntax for the `WP_Filesystem_Base::dirlist()` DocBlock.

See #28298.


git-svn-id: https://develop.svn.wordpress.org/trunk@30722 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-12-03 10:10:07 +00:00
parent a5ad473d00
commit e3957f278e
1 changed files with 11 additions and 10 deletions

View File

@ -787,6 +787,7 @@ class WP_Filesystem_Base {
* *
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $path Path to directory or file. * @param string $path Path to directory or file.
* @param bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files. * @param bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
* Default true. * Default true.
@ -795,16 +796,16 @@ class WP_Filesystem_Base {
* @return array|bool { * @return array|bool {
* Array of files. False if unable to list directory contents. * Array of files. False if unable to list directory contents.
* *
* @type string 'name' Name of the file/directory. * @type string $name Name of the file/directory.
* @type string 'perms' *nix representation of permissions. * @type string $perms *nix representation of permissions.
* @type int 'permsn' Octal representation of permissions. * @type int $permsn Octal representation of permissions.
* @type string 'owner' Owner name or ID. * @type string $owner Owner name or ID.
* @type int 'size' Size of file in bytes. * @type int $size Size of file in bytes.
* @type int 'lastmodunix' Last modified unix timestamp. * @type int $lastmodunix Last modified unix timestamp.
* @type mixed 'lastmod' Last modified month (3 letter) and day (without leading 0). * @type mixed $lastmod Last modified month (3 letter) and day (without leading 0).
* @type int 'time' Last modified time. * @type int $time Last modified time.
* @type string 'type' Type of resource. 'f' for file, 'd' for directory. * @type string $type Type of resource. 'f' for file, 'd' for directory.
* @type mixed 'files' If a directory and $recursive is true, contains another array of files. * @type mixed $files If a directory and $recursive is true, contains another array of files.
* } * }
*/ */
public function dirlist( $path, $include_hidden = true, $recursive = false ) { public function dirlist( $path, $include_hidden = true, $recursive = false ) {