Make WordPress Core


Ignore:
Timestamp:
12/01/2014 12:12:05 AM (10 years ago)
Author:
wonderboymusic
Message:

Improve various @param docs for src/wp-admin/includes/class-wp-filesystem-*.php.

See #30224.

File:
1 edited

Legend:

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

    r29454 r30678  
    470470     *
    471471     * @since 2.5.0
    472      *
     472     * @abstract
    473473     * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
    474474     */
     
    481481     *
    482482     * @since 2.5.0
    483      *
     483     * @abstract
    484484     * @param string $file Name of the file to read.
    485      * @return string|bool Returns the read data or false on failure.
     485     * @return mixed|bool Returns the read data or false on failure.
    486486     */
    487487    public function get_contents( $file ) {
     
    493493     *
    494494     * @since 2.5.0
    495      *
     495     * @abstract
    496496     * @param string $file Path to the file.
    497497     * @return array|bool the file contents in an array or false on failure.
     
    505505     *
    506506     * @since 2.5.0
    507      *
     507     * @abstract
    508508     * @param string $file     Remote path to the file where to write the data.
    509509     * @param string $contents The data to write.
     
    519519     *
    520520     * @since 2.5.0
    521      *
     521     * @abstract
    522522     * @return string|bool The current working directory on success, or false on failure.
    523523     */
     
    530530     *
    531531     * @since 2.5.0
    532      *
     532     * @abstract
    533533     * @param string $dir The new current directory.
    534534     * @return bool Returns true on success or false on failure.
     
    542542     *
    543543     * @since 2.5.0
    544      *
     544     * @abstract
    545545     * @param string $file      Path to the file.
    546546     * @param mixed  $group     A group name or number.
     
    556556     *
    557557     * @since 2.5.0
    558      *
     558     * @abstract
    559559     * @param string $file      Path to the file.
    560560     * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
     
    570570     *
    571571     * @since 2.5.0
    572      *
     572     * @abstract
    573573     * @param string $file Path to the file.
    574574     * @return string|bool Username of the user or false on error.
     
    582582     *
    583583     * @since 2.5.0
    584      *
     584     * @abstract
    585585     * @param string $file Path to the file.
    586586     * @return string|bool The group or false on error.
     
    594594     *
    595595     * @since 2.5.0
    596      *
     596     * @abstract
    597597     * @param string $source      Path to the source file.
    598598     * @param string $destination Path to the destination file.
     
    611611     *
    612612     * @since 2.5.0
    613      *
     613     * @abstract
    614614     * @param string $source      Path to the source file.
    615615     * @param string $destination Path to the destination file.
     
    626626     *
    627627     * @since 2.5.0
    628      *
     628     * @abstract
    629629     * @param string $file      Path to the file.
    630630     * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
     
    642642     *
    643643     * @since 2.5.0
    644      *
     644     * @abstract
    645645     * @param string $file Path to file/directory.
    646646     * @return bool Whether $file exists or not.
     
    654654     *
    655655     * @since 2.5.0
    656      *
     656     * @abstract
    657657     * @param string $file File path.
    658658     * @return bool Whether $file is a file.
     
    666666     *
    667667     * @since 2.5.0
    668      *
     668     * @abstract
    669669     * @param string $path Directory path.
    670670     * @return bool Whether $path is a directory.
     
    678678     *
    679679     * @since 2.5.0
    680      *
     680     * @abstract
    681681     * @param string $file Path to file.
    682682     * @return bool Whether $file is readable.
     
    690690     *
    691691     * @since 2.5.0
    692      *
    693      * @param string $path Path to file/directory.
     692     * @abstract
    694693     * @return bool Whether $file is writable.
    695694     */
     
    702701     *
    703702     * @since 2.5.0
    704      *
     703     * @abstract
    705704     * @param string $file Path to file.
    706      * @return int Unix timestamp representing last access time.
     705     * @return int|bool Unix timestamp representing last access time.
    707706     */
    708707    public function atime( $file ) {
     
    714713     *
    715714     * @since 2.5.0
    716      *
     715     * @abstract
    717716     * @param string $file Path to file.
    718      * @return int Unix timestamp representing modification time.
     717     * @return int|bool Unix timestamp representing modification time.
    719718     */
    720719    public function mtime( $file ) {
     
    726725     *
    727726     * @since 2.5.0
    728      *
     727     * @abstract
    729728     * @param string $file Path to file.
    730      * @return int Size of the file in bytes.
     729     * @return int|bool Size of the file in bytes.
    731730     */
    732731    public function size( $file ) {
     
    740739     *
    741740     * @since 2.5.0
    742      *
     741     * @abstract
    743742     * @param string $file  Path to file.
    744743     * @param int    $time  Optional. Modified time to set for file.
     
    756755     *
    757756     * @since 2.5.0
    758      *
     757     * @abstract
    759758     * @param string $path  Path for new directory.
    760759     * @param mixed  $chmod Optional. The permissions as octal number, (or False to skip chmod)
     
    774773     *
    775774     * @since 2.5.0
    776      *
     775     * @abstract
    777776     * @param string $path      Path to directory.
    778777     * @param bool   $recursive Optional. Whether to recursively remove files/directories.
     
    788787     *
    789788     * @since 2.5.0
    790      *
     789     * @abstract
    791790     * @param string $path           Path to directory or file.
    792791     * @param bool   $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
Note: See TracChangeset for help on using the changeset viewer.