WordPress.org

Make WordPress Core

Changeset 31884


Ignore:
Timestamp:
03/25/2015 04:31:15 PM (6 years ago)
Author:
DrewAPicture
Message:

Clean up DocBlock information and syntax for get_filesystem_method().

Props ericlewis, HarishChaudhari, valendesigns.
Fixes #31267.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/file.php

    r31811 r31884  
    873873
    874874/**
    875  * Determines which Filesystem Method to use.
    876  *
    877  * The priority of the Transports are: Direct, SSH2, FTP PHP Extension,
    878  * FTP Sockets (Via Sockets class, or `fsockopen()`).
    879  *
    880  * Note that the return value of this function can be overridden in 2 ways
    881  *
    882  *  - By defining FS_METHOD in your `wp-config.php` file
    883  *  - By using the filesystem_method filter
    884  *
    885  * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
    886  *
    887  * Plugins may also define a custom transport handler, See the WP_Filesystem
    888  * function for more information.
     875 * Determines which method to use for reading, writing, modifying, or deleting
     876 * files on the filesystem.
     877 *
     878 * The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
     879 * (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
     880 * 'ftpext' or 'ftpsockets'.
     881 *
     882 * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
     883 * or filtering via {@see 'filesystem_method'}.
     884 *
     885 * @link https://codex.wordpress.org/Editing_wp-config.php#WordPress_Upgrade_Constants
     886 *
     887 * Plugins may define a custom transport handler, See WP_Filesystem().
    889888 *
    890889 * @since 2.5.0
    891890 *
    892  * @todo Properly mark arguments as optional.
    893  *
    894  * @param array $args Connection details.
    895  * @param string $context Full path to the directory that is tested for being writable.
    896  * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
     891 * @param array  $args                         Optional. Connection details. Default empty array.
     892 * @param string $context                      Optional. Full path to the directory that is tested
     893 *                                             for being writable. Default false.
     894 * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
     895 *                                             Default false.
    897896 * @return string The transport to use, see description for valid return values.
    898897 */
Note: See TracChangeset for help on using the changeset viewer.