Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:39:34 AM (7 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-admin/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the @access notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

File:
1 edited

Legend:

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

    r37985 r41161  
    1616     * Whether to display debug data for the connection.
    1717     *
    18      * @access public
    1918     * @since 2.5.0
    2019     * @var bool
     
    2524     * Cached list of local filepaths to mapped remote filepaths.
    2625     *
    27      * @access public
    2826     * @since 2.7.0
    2927     * @var array
     
    3432     * The Access method of the current connection, Set automatically.
    3533     *
    36      * @access public
    3734     * @since 2.5.0
    3835     * @var string
     
    4138
    4239    /**
    43      * @access public
    4440     * @var WP_Error
    4541     */
     
    4743
    4844    /**
    49      * @access public
    5045     */
    5146    public $options = array();
     
    5449     * Return the path on the remote filesystem of ABSPATH.
    5550     *
    56      * @access public
    5751     * @since 2.7.0
    5852     *
     
    7064     * Return the path on the remote filesystem of WP_CONTENT_DIR.
    7165     *
    72      * @access public
    7366     * @since 2.7.0
    7467     *
     
    8275     * Return the path on the remote filesystem of WP_PLUGIN_DIR.
    8376     *
    84      * @access public
    8577     * @since 2.7.0
    8678     *
     
    9486     * Return the path on the remote filesystem of the Themes Directory.
    9587     *
    96      * @access public
    9788     * @since 2.7.0
    9889     *
     
    113104     * Return the path on the remote filesystem of WP_LANG_DIR.
    114105     *
    115      * @access public
    116106     * @since 3.2.0
    117107     *
     
    125115     * Locate a folder on the remote filesystem.
    126116     *
    127      * @access public
    128117     * @since 2.5.0
    129118     * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() instead.
     
    148137     * Locate a folder on the remote filesystem.
    149138     *
    150      * @access public
    151139     * @since 2.5.0
    152140     * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() methods instead.
     
    173161     * letter is OK Sanitizes \\ to / in windows filepaths.
    174162     *
    175      * @access public
    176163     * @since 2.7.0
    177164     *
     
    239226     * Expects Windows sanitized path.
    240227     *
    241      * @access public
    242228     * @since 2.7.0
    243229     *
     
    320306     * @link https://secure.php.net/manual/en/function.fileperms.php
    321307     *
    322      * @access public
    323308     * @since 2.5.0
    324309     *
     
    371356     * Gets the permissions of the specified file or filepath in their octal format
    372357     *
    373      * @access public
    374358     * @since 2.5.0
    375359     * @param string $file
     
    388372     * @link https://secure.php.net/manual/en/function.chmod.php#49614
    389373     *
    390      * @access public
    391374     * @since 2.5.0
    392375     *
     
    419402     * Determine if the string provided contains binary characters.
    420403     *
    421      * @access public
    422404     * @since 2.7.0
    423405     *
     
    434416     * Default behavior is to do nothing, override this in your subclass, if desired.
    435417     *
    436      * @access public
    437418     * @since 2.5.0
    438419     *
     
    449430     * Connect filesystem.
    450431     *
    451      * @access public
    452432     * @since 2.5.0
    453433     * @abstract
     
    462442     * Read entire file into a string.
    463443     *
    464      * @access public
    465444     * @since 2.5.0
    466445     * @abstract
     
    476455     * Read entire file into an array.
    477456     *
    478      * @access public
    479457     * @since 2.5.0
    480458     * @abstract
     
    490468     * Write a string to a file.
    491469     *
    492      * @access public
    493470     * @since 2.5.0
    494471     * @abstract
     
    506483     * Get the current working directory.
    507484     *
    508      * @access public
    509485     * @since 2.5.0
    510486     * @abstract
     
    519495     * Change current directory.
    520496     *
    521      * @access public
    522497     * @since 2.5.0
    523498     * @abstract
     
    533508     * Change the file group.
    534509     *
    535      * @access public
    536510     * @since 2.5.0
    537511     * @abstract
     
    549523     * Change filesystem permissions.
    550524     *
    551      * @access public
    552525     * @since 2.5.0
    553526     * @abstract
     
    565538     * Get the file owner.
    566539     *
    567      * @access public
    568540     * @since 2.5.0
    569541     * @abstract
     
    579551     * Get the file's group.
    580552     *
    581      * @access public
    582553     * @since 2.5.0
    583554     * @abstract
     
    593564     * Copy a file.
    594565     *
    595      * @access public
    596566     * @since 2.5.0
    597567     * @abstract
     
    612582     * Move a file.
    613583     *
    614      * @access public
    615584     * @since 2.5.0
    616585     * @abstract
     
    629598     * Delete a file or directory.
    630599     *
    631      * @access public
    632600     * @since 2.5.0
    633601     * @abstract
     
    647615     * Check if a file or directory exists.
    648616     *
    649      * @access public
    650617     * @since 2.5.0
    651618     * @abstract
     
    661628     * Check if resource is a file.
    662629     *
    663      * @access public
    664630     * @since 2.5.0
    665631     * @abstract
     
    675641     * Check if resource is a directory.
    676642     *
    677      * @access public
    678643     * @since 2.5.0
    679644     * @abstract
     
    689654     * Check if a file is readable.
    690655     *
    691      * @access public
    692656     * @since 2.5.0
    693657     * @abstract
     
    703667     * Check if a file or directory is writable.
    704668     *
    705      * @access public
    706669     * @since 2.5.0
    707670     * @abstract
     
    717680     * Gets the file's last access time.
    718681     *
    719      * @access public
    720682     * @since 2.5.0
    721683     * @abstract
     
    731693     * Gets the file modification time.
    732694     *
    733      * @access public
    734695     * @since 2.5.0
    735696     * @abstract
     
    745706     * Gets the file size (in bytes).
    746707     *
    747      * @access public
    748708     * @since 2.5.0
    749709     * @abstract
     
    761721     * Note: If $file doesn't exist, it will be created.
    762722     *
    763      * @access public
    764723     * @since 2.5.0
    765724     * @abstract
     
    779738     * Create a directory.
    780739     *
    781      * @access public
    782740     * @since 2.5.0
    783741     * @abstract
     
    799757     * Delete a directory.
    800758     *
    801      * @access public
    802759     * @since 2.5.0
    803760     * @abstract
     
    815772     * Get details for files in a directory or a specific file.
    816773     *
    817      * @access public
    818774     * @since 2.5.0
    819775     * @abstract
Note: See TracChangeset for help on using the changeset viewer.