Ticket #31267: 31267.diff

src/wp-admin/includes/file.php

@@ -872 +872 @@
 }
 
 /**
- * Determines which Filesystem Method to use.
+ * Determines which method to use for reading, writing, modifying, and deleting
+ * files on the file system.
  *
- * The priority of the Transports are: Direct, SSH2, FTP PHP Extension,
+ * The priority of the transports are: Direct, SSH2, FTP PHP Extension,
  * FTP Sockets (Via Sockets class, or `fsockopen()`).
  *
- * Note that the return value of this function can be overridden in 2 ways
+ * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
  *
- *  - By defining FS_METHOD in your `wp-config.php` file
- *  - By using the filesystem_method filter
+ * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
+ * or filtering via the `filesystem_method` filter.
  *
- * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
+ * Plugins may define a custom transport handler, @see WP_Filesystem().
  *
- * Plugins may also define a custom transport handler, See the WP_Filesystem
- * function for more information.
- *
  * @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                         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.
  * @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 ) {