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

Timestamp:

10/26/2019 11:14:59 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Update the docs for the error parameter that gets passed around during filesystem credential collection.

See #48303

File:

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

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

@@ -77 +77 @@
      * @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.
+     * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
+     *                                                    or an error object. 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.
      */