From bd2d4c8d14cc3f636ccb5a330033923cb2e3662b Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Wed, 25 Mar 2015 16:31:15 +0000 Subject: [PATCH] Clean up DocBlock information and syntax for `get_filesystem_method()`. Props ericlewis, HarishChaudhari, valendesigns. Fixes #31267. git-svn-id: https://develop.svn.wordpress.org/trunk@31884 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/file.php | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/src/wp-admin/includes/file.php b/src/wp-admin/includes/file.php index 9f3e6bab24..513b417487 100644 --- a/src/wp-admin/includes/file.php +++ b/src/wp-admin/includes/file.php @@ -872,28 +872,27 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own } /** - * Determines which Filesystem Method to use. + * Determines which method to use for reading, writing, modifying, or deleting + * files on the filesystem. * - * The priority of the Transports are: Direct, SSH2, FTP PHP Extension, - * FTP Sockets (Via Sockets class, or `fsockopen()`). + * The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets + * (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2', + * 'ftpext' or 'ftpsockets'. * - * Note that the return value of this function can be overridden in 2 ways + * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`, + * or filtering via {@see 'filesystem_method'}. * - * - By defining FS_METHOD in your `wp-config.php` file - * - By using the filesystem_method filter + * @link https://codex.wordpress.org/Editing_wp-config.php#WordPress_Upgrade_Constants * - * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'. - * - * Plugins may also define a custom transport handler, See the WP_Filesystem - * function for more information. + * Plugins may define a custom transport handler, See WP_Filesystem(). * * @since 2.5.0 * - * @todo Properly mark arguments as optional. - * - * @param array $args Connection details. - * @param string $context Full path to the directory that is tested for being writable. - * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. + * @param array $args Optional. Connection details. Default empty array. + * @param string $context Optional. Full path to the directory that is tested + * for being writable. Default false. + * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. + * Default false. * @return string The transport to use, see description for valid return values. */ function get_filesystem_method( $args = array(), $context = false, $allow_relaxed_file_ownership = false ) {