WordPress.org
Get WordPress

Make WordPress Core

Changeset 55714 for trunk


Ignore:
Timestamp:
05/03/2023 09:28:11 PM (3 years ago)
Author:
johnbillion
Message:

Filesystem API: Correct and improve the return type documentation for the dirlist() method in WP_Filesystem_Base and its extending classes.

Props mat-lipe, szepeviktor, costdev, audrasjb, johnbillion

Fixes #58229
See #57840

Location:
trunk/src/wp-admin/includes
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-filesystem-base.php

    r54133 r55714  
    828828         *                               Default false.
    829829         * @return array|false {
    830          *     Array of files. False if unable to list directory contents.
    831          *
    832          *     @type string $name        Name of the file or directory.
    833          *     @type string $perms       *nix representation of permissions.
    834          *     @type string $permsn      Octal representation of permissions.
    835          *     @type string $owner       Owner name or ID.
    836          *     @type int    $size        Size of file in bytes.
    837          *     @type int    $lastmodunix Last modified unix timestamp.
    838          *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
    839          *     @type int    $time        Last modified time.
    840          *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
    841          *     @type mixed  $files       If a directory and `$recursive` is true, contains another array of files.
     830         *     Array of arrays containing file information. False if unable to list directory contents.
     831         *
     832         *     @type array $0... {
     833         *         Array of file information. Note that some elements may not be available on all filesystems.
     834         *
     835         *         @type string           $name        Name of the file or directory.
     836         *         @type string           $perms       *nix representation of permissions.
     837         *         @type string           $permsn      Octal representation of permissions.
     838         *         @type int|string|false $number      File number. May be a numeric string. False if not available.
     839         *         @type string|false     $owner       Owner name or ID, or false if not available.
     840         *         @type string|false     $group       File permissions group, or false if not available.
     841         *         @type int|string|false $size        Size of file in bytes. May be a numeric string.
     842         *                                             False if not available.
     843         *         @type int|string|false $lastmodunix Last modified unix timestamp. May be a numeric string.
     844         *                                             False if not available.
     845         *         @type string|false     $lastmod     Last modified month (3 letters) and day (without leading 0), or
     846         *                                             false if not available.
     847         *         @type string|false     $time        Last modified time, or false if not available.
     848         *         @type string           $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     849         *         @type array|false      $files       If a directory and `$recursive` is true, contains another array of
     850         *                                             files. False if unable to list directory contents.
     851         *     }
    842852         * }
    843853         */

  • trunk/src/wp-admin/includes/class-wp-filesystem-direct.php

    r55354 r55714  
    598598         *                               Default false.
    599599         * @return array|false {
    600          *     Array of files. False if unable to list directory contents.
    601          *
    602          *     @type string $name        Name of the file or directory.
    603          *     @type string $perms       *nix representation of permissions.
    604          *     @type string $permsn      Octal representation of permissions.
    605          *     @type string $owner       Owner name or ID.
    606          *     @type int    $size        Size of file in bytes.
    607          *     @type int    $lastmodunix Last modified unix timestamp.
    608          *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
    609          *     @type int    $time        Last modified time.
    610          *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
    611          *     @type mixed  $files       If a directory and `$recursive` is true, contains another array of files.
     600         *     Array of arrays containing file information. False if unable to list directory contents.
     601         *
     602         *     @type array $0... {
     603         *         Array of file information. Note that some elements may not be available on all filesystems.
     604         *
     605         *         @type string           $name        Name of the file or directory.
     606         *         @type string           $perms       *nix representation of permissions.
     607         *         @type string           $permsn      Octal representation of permissions.
     608         *         @type false            $number      File number. Always false in this context.
     609         *         @type string|false     $owner       Owner name or ID, or false if not available.
     610         *         @type string|false     $group       File permissions group, or false if not available.
     611         *         @type int|string|false $size        Size of file in bytes. May be a numeric string.
     612         *                                             False if not available.
     613         *         @type int|string|false $lastmodunix Last modified unix timestamp. May be a numeric string.
     614         *                                             False if not available.
     615         *         @type string|false     $lastmod     Last modified month (3 letters) and day (without leading 0), or
     616         *                                             false if not available.
     617         *         @type string|false     $time        Last modified time, or false if not available.
     618         *         @type string           $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     619         *         @type array|false      $files       If a directory and `$recursive` is true, contains another array of
     620         *                                             files. False if unable to list directory contents.
     621         *     }
    612622         * }
    613623         */

  • trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php

    r55556 r55714  
    603603        /**
    604604         * @param string $line
    605          * @return array
     605         * @return array {
     606         *     Array of file information.
     607         *
     608         *     @type string       $name        Name of the file or directory.
     609         *     @type string       $perms       *nix representation of permissions.
     610         *     @type string       $permsn      Octal representation of permissions.
     611         *     @type string|false $number      File number as a string, or false if not available.
     612         *     @type string|false $owner       Owner name or ID, or false if not available.
     613         *     @type string|false $group       File permissions group, or false if not available.
     614         *     @type string|false $size        Size of file in bytes as a string, or false if not available.
     615         *     @type string|false $lastmodunix Last modified unix timestamp as a string, or false if not available.
     616         *     @type string|false $lastmod     Last modified month (3 letters) and day (without leading 0), or
     617         *                                     false if not available.
     618         *     @type string|false $time        Last modified time, or false if not available.
     619         *     @type string       $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     620         *     @type array|false  $files       If a directory and `$recursive` is true, contains another array of files.
     621         *                                     False if unable to list directory contents.
     622         * }
    606623         */
    607624        public function parselisting( $line ) {
    … …  
    713730         *                               Default false.
    714731         * @return array|false {
    715          *     Array of files. False if unable to list directory contents.
    716          *
    717          *     @type string $name        Name of the file or directory.
    718          *     @type string $perms       *nix representation of permissions.
    719          *     @type string $permsn      Octal representation of permissions.
    720          *     @type string $owner       Owner name or ID.
    721          *     @type int    $size        Size of file in bytes.
    722          *     @type int    $lastmodunix Last modified unix timestamp.
    723          *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
    724          *     @type int    $time        Last modified time.
    725          *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
    726          *     @type mixed  $files       If a directory and `$recursive` is true, contains another array of files.
     732         *     Array of arrays containing file information. False if unable to list directory contents.
     733         *
     734         *     @type array $0... {
     735         *         Array of file information. Note that some elements may not be available on all filesystems.
     736         *
     737         *         @type string           $name        Name of the file or directory.
     738         *         @type string           $perms       *nix representation of permissions.
     739         *         @type string           $permsn      Octal representation of permissions.
     740         *         @type int|string|false $number      File number. May be a numeric string. False if not available.
     741         *         @type string|false     $owner       Owner name or ID, or false if not available.
     742         *         @type string|false     $group       File permissions group, or false if not available.
     743         *         @type int|string|false $size        Size of file in bytes. May be a numeric string.
     744         *                                             False if not available.
     745         *         @type int|string|false $lastmodunix Last modified unix timestamp. May be a numeric string.
     746         *                                             False if not available.
     747         *         @type string|false     $lastmod     Last modified month (3 letters) and day (without leading 0), or
     748         *                                             false if not available.
     749         *         @type string|false     $time        Last modified time, or false if not available.
     750         *         @type string           $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     751         *         @type array|false      $files       If a directory and `$recursive` is true, contains another array of
     752         *                                             files. False if unable to list directory contents.
     753         *     }
    727754         * }
    728755         */

  • trunk/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php

    r55641 r55714  
    624624         *                               Default false.
    625625         * @return array|false {
    626          *     Array of files. False if unable to list directory contents.
    627          *
    628          *     @type string $name        Name of the file or directory.
    629          *     @type string $perms       *nix representation of permissions.
    630          *     @type string $permsn      Octal representation of permissions.
    631          *     @type string $owner       Owner name or ID.
    632          *     @type int    $size        Size of file in bytes.
    633          *     @type int    $lastmodunix Last modified unix timestamp.
    634          *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
    635          *     @type int    $time        Last modified time.
    636          *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
    637          *     @type mixed  $files       If a directory and `$recursive` is true, contains another array of files.
     626         *     Array of arrays containing file information. False if unable to list directory contents.
     627         *
     628         *     @type array $0... {
     629         *         Array of file information. Note that some elements may not be available on all filesystems.
     630         *
     631         *         @type string           $name        Name of the file or directory.
     632         *         @type string           $perms       *nix representation of permissions.
     633         *         @type string           $permsn      Octal representation of permissions.
     634         *         @type int|string|false $number      File number. May be a numeric string. False if not available.
     635         *         @type string|false     $owner       Owner name or ID, or false if not available.
     636         *         @type string|false     $group       File permissions group, or false if not available.
     637         *         @type int|string|false $size        Size of file in bytes. May be a numeric string.
     638         *                                             False if not available.
     639         *         @type int|string|false $lastmodunix Last modified unix timestamp. May be a numeric string.
     640         *                                             False if not available.
     641         *         @type string|false     $lastmod     Last modified month (3 letters) and day (without leading 0), or
     642         *                                             false if not available.
     643         *         @type string|false     $time        Last modified time, or false if not available.
     644         *         @type string           $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     645         *         @type array|false      $files       If a directory and `$recursive` is true, contains another array of
     646         *                                             files. False if unable to list directory contents.
     647         *     }
    638648         * }
    639649         */

  • trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

    r55354 r55714  
    742742         *                               Default false.
    743743         * @return array|false {
    744          *     Array of files. False if unable to list directory contents.
    745          *
    746          *     @type string $name        Name of the file or directory.
    747          *     @type string $perms       *nix representation of permissions.
    748          *     @type string $permsn      Octal representation of permissions.
    749          *     @type string $owner       Owner name or ID.
    750          *     @type int    $size        Size of file in bytes.
    751          *     @type int    $lastmodunix Last modified unix timestamp.
    752          *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
    753          *     @type int    $time        Last modified time.
    754          *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
    755          *     @type mixed  $files       If a directory and `$recursive` is true, contains another array of files.
     744         *     Array of arrays containing file information. False if unable to list directory contents.
     745         *
     746         *     @type array $0... {
     747         *         Array of file information. Note that some elements may not be available on all filesystems.
     748         *
     749         *         @type string           $name        Name of the file or directory.
     750         *         @type string           $perms       *nix representation of permissions.
     751         *         @type string           $permsn      Octal representation of permissions.
     752         *         @type false            $number      File number. Always false in this context.
     753         *         @type string|false     $owner       Owner name or ID, or false if not available.
     754         *         @type string|false     $group       File permissions group, or false if not available.
     755         *         @type int|string|false $size        Size of file in bytes. May be a numeric string.
     756         *                                             False if not available.
     757         *         @type int|string|false $lastmodunix Last modified unix timestamp. May be a numeric string.
     758         *                                             False if not available.
     759         *         @type string|false     $lastmod     Last modified month (3 letters) and day (without leading 0), or
     760         *                                             false if not available.
     761         *         @type string|false     $time        Last modified time, or false if not available.
     762         *         @type string           $type        Type of resource. 'f' for file, 'd' for directory, 'l' for link.
     763         *         @type array|false      $files       If a directory and `$recursive` is true, contains another array of
     764         *                                             files. False if unable to list directory contents.
     765         *     }
    756766         * }
    757767         */
Note: See TracChangeset for help on using the changeset viewer.