Changeset 38138

Timestamp:

07/22/2016 12:09:55 PM (10 years ago)

Author:

ocean90

Message:

Filesystem API: Change the default value for the $context parameter of get_filesystem_method() and request_filesystem_credentials() to an empty string.

$context is a full path to the directory that is tested for being writable. A path shouldn't be a boolean value.
This also updates WP_Upgrader_Skin::request_filesystem_credentials() and Automatic_Upgrader_Skin::request_filesystem_credentials() and adds missing docs.

Props DrewAPicture, ocean90.
Fixes #37412.

Location:

trunk/src/wp-admin/includes

Files:

• class-automatic-upgrader-skin.php (modified) (1 diff)
• class-wp-upgrader-skin.php (modified) (1 diff)
• file.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

@@ -23 +23 @@
 
         /**
+         * Determines whether the upgrader needs FTP/SSH details in order to connect
+         * to the filesystem.
          *
-         * @param bool   $error
-         * @param string $context
-         * @param bool   $allow_relaxed_file_ownership
-         * @return bool
+         * @since 3.7.0
+         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
+         *
+         * @see request_filesystem_credentials()
+         *
+         * @param bool   $error                        Optional. Whether the current request has failed to connect.
+         *                                             Default false.
+         * @param string $context                      Optional. Full path to the directory that is tested
+         *                                             for being writable. Default empty.
+         * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
+         * @return bool True on success, false on failure.
          */
         public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {

trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

@@ -67 +67 @@
 
         /**
-         *
-         * @param bool   $error
-         * @param string $context
-         * @param bool   $allow_relaxed_file_ownership
-         * @return type
-         */
-        public function request_filesystem_credentials( $error = false, $context = false, $allow_relaxed_file_ownership = false ) {
+         * Displays a form to the user to request for their FTP/SSH details in order
+         * to connect to the filesystem.
+         *
+         * @since 2.8.0
+         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
+         *
+         * @see request_filesystem_credentials()
+         *
+         * @param bool   $error                        Optional. Whether the current request has failed to connect.
+         *                                             Default false.
+         * @param string $context                      Optional. Full path to the directory that is tested
+         *                                             for being writable. Default empty.
+         * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
+         * @return bool False on failure, true on success.
+         */
+        public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {
                 $url = $this->options['url'];
                 if ( ! $context ) {

trunk/src/wp-admin/includes/file.php

@@ -958 +958 @@
  * @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.
+ *                                             for being writable. Default empty.
  * @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 ) {
+function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
         $method = defined('FS_METHOD') ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
 
@@ -1028 +1028 @@
  * to connect to the filesystem.
  *
- * All chosen/entered details are saved, Excluding the Password.
+ * All chosen/entered details are saved, excluding the password.
  *
  * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
  * to specify an alternate FTP/SSH port.
  *
- * Plugins may override this form by returning true|false via the
- * {@see 'request_filesystem_credentials'} filter.
- *
- * @since 2.5.
+ * Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
+ *
+ * @since 2.5.0
+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
  *
  * @global string $pagenow
@@ -1044 +1044 @@
  * @param bool   $error                        Optional. Whether the current request has failed to connect.
  *                                             Default false.
- * @param string $context                      Optional. Full path to the directory that is tested
- *                                             for being writable. Default false.
- * @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.
+ * @param string $context                      Optional. Full path to the directory that is tested for being
+ *                                             writable. Default empty.
+ * @param array  $extra_fields                 Optional. Extra `POST` fields to be checked for inclusion 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 = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
         global $pagenow;
 
@@ -1063 +1062 @@
          *
          * @since 2.5.0
+         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
          *
          * @param mixed  $output                       Form output to return instead. Default empty.
@@ -1161 +1161 @@
          *
          * @since 2.9.0
+         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
          *
          * @param array  $types       Types of connections.