WordPress.org

Make WordPress Core

Changeset 34495


Ignore:
Timestamp:
09/24/2015 02:21:50 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Add a summary, version, and parameter and return descriptions to the DocBlock for WP_Filesystem_ftpsockets::get_contents().

Also reverses the return types as string is expected, false is the outlier.

See [30978].

See #30989. See #32246.

File:
1 edited

Legend:

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

    r33984 r34495  
    9292
    9393    /**
    94      * @access public
    95      *
    96      * @param string $file
    97      * @return false|string
     94     * Retrieves the file contents.
     95     *
     96     * @since 2.5.0
     97     * @access public
     98     *
     99     * @param string $file Filename.
     100     * @return string|false File contents on success, false if no temp file could be opened,
     101     *                      or if the file doesn't exist.
    98102     */
    99103    public function get_contents( $file ) {
Note: See TracChangeset for help on using the changeset viewer.