WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Improve documentation for `request_filesystem_credentials()` and the corresponding filter. 

Props swissspidy, danhgilmore, slushman.
Fixes #34858.
Built from https://develop.svn.wordpress.org/trunk@35888


git-svn-id: http://core.svn.wordpress.org/trunk@35852 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2015-12-12 16:16:26 +00:00
parent 56a31f392b
commit 3f61b6bafa
2 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
wp-admin/includes/file.php
View File

@ -1011,17 +1011,20 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe
* *
* @since 2.5. * @since 2.5.
* *
* @todo Properly mark optional arguments as such
*
* @global string $pagenow * @global string $pagenow
* *
* @param string $form_post the URL to post the form to * @param string $form_post The URL to post the form to.
* @param string $type the chosen Filesystem method in use * @param string $type Optional. Chosen type of filesystem. Default empty.
* @param bool $error if the current request has failed to connect * @param bool $error Optional. Whether the current request has failed to connect.
* @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method() * Default false.
* @param array $extra_fields Extra POST fields which should be checked for to be included in the post. * @param string $context Optional. Full path to the directory that is tested
* @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. * for being writable. Default false.
* @return bool False on failure. True on success. * @param array $extra_fields Optional. Extra POST fields which should be checked for
* to be included in the post. Default null.
* @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
* Default false.
*
* @return bool False on failure, true on success.
*/ */
function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) { function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
global $pagenow; global $pagenow;
@ -1035,13 +1038,14 @@ function request_filesystem_credentials($form_post, $type = '', $error = false,
* @since 2.5.0 * @since 2.5.0
* *
* @param mixed $output Form output to return instead. Default empty. * @param mixed $output Form output to return instead. Default empty.
* @param string $form_post URL to POST the form to. * @param string $form_post The URL to post the form to.
* @param string $type Chosen type of filesystem. * @param string $type Chosen type of filesystem.
* @param bool $error Whether the current request has failed to connect. * @param bool $error Whether the current request has failed to connect.
* Default false. * Default false.
* @param string $context Full path to the directory that is tested for * @param string $context Full path to the directory that is tested for
* being writable. * being writable.
* @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
* Default false.
* @param array $extra_fields Extra POST fields. * @param array $extra_fields Extra POST fields.
*/ */
$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership ); $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-35887'; $wp_version = '4.5-alpha-35888';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.