Make WordPress Core

Ticket #31267: 31267.2.patch

File 31267.2.patch, 2.1 KB (added by HarishChaudhari, 9 years ago)

Updated PHP documentation as suggested by @DrewAPicture

  • file.php

     
    872872}
    873873
    874874/**
    875  * Determines which Filesystem Method to use.
     875 * Determines which method to use for reading, writing, modifying or deleting
     876 * files on the file system.
    876877 *
    877  * The priority of the Transports are: Direct, SSH2, FTP PHP Extension,
     878 * The priority of the transports are: Direct, SSH2, FTP PHP Extension,
    878879 * FTP Sockets (Via Sockets class, or `fsockopen()`).
     880 * Valid values for these are: 'direct', 'ssh2', 'ftpext' or 'ftpsockets'.
     881 * @link https://codex.wordpress.org/Editing_wp-config.php#WordPress_Upgrade_Constants
    879882 *
    880  * Note that the return value of this function can be overridden in 2 ways
     883 * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
     884 * or filtering via the `filesystem_method` filter.
    881885 *
    882  *  - By defining FS_METHOD in your `wp-config.php` file
    883  *  - By using the filesystem_method filter
     886 * Plugins may define a custom transport handler, {@see WP_Filesystem()}
    884887 *
    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.
    889  *
    890888 * @since 2.5.0
    891889 *
    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.
     890 * @param array  $args                         Optional. Connection details. Default empty array.
     891 * @param string $context                      Optional. Full path to the directory that is tested
     892 *                                              for being writable. Default false.
     893 * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
     894 *                                              Default false.
    897895 * @return string The transport to use, see description for valid return values.
    898896 */
    899897function get_filesystem_method( $args = array(), $context = false, $allow_relaxed_file_ownership = false ) {