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

Timestamp:

07/22/2016 12:09:55 PM (9 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.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader-skin.php (modified) (1 diff)

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 ) {