Changeset 46597

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

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) (3 diffs)

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

@@ -31 +31 @@
      * @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 True on success, false on failure.
      */

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.
      */

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

@@ -1932 +1932 @@
  * @global string $pagenow
  *
- * @param string $form_post                    The URL to post the form to.
- * @param string $type                         Optional. Chosen type of filesystem. Default empty.
- * @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 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.
+ * @param string        $form_post                    The URL to post the form to.
+ * @param string        $type                         Optional. Chosen type of filesystem. Default empty.
+ * @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 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 True on success, false on failure.
@@ -1956 +1956 @@
      * @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.
-     * @param string $form_post                    The URL to post the form to.
-     * @param string $type                         Chosen type of filesystem.
-     * @param bool   $error                        Whether the current request has failed to connect.
-     *                                             Default false.
-     * @param string $context                      Full path to the directory that is tested for
-     *                                             being writable.
-     * @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
-     *                                             Default false.
-     * @param array  $extra_fields                 Extra POST fields.
+     * @param mixed         $output                       Form output to return instead. Default empty.
+     * @param string        $form_post                    The URL to post the form to.
+     * @param string        $type                         Chosen type of filesystem.
+     * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
+     *                                                    or an error object. Default false.
+     * @param string        $context                      Full path to the directory that is tested for
+     *                                                    being writable.
+     * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
+     *                                                    Default false.
+     * @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 );
@@ -2084 +2084 @@
      * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
      *
-     * @param array  $types       Types of connections.
-     * @param array  $credentials Credentials to connect with.
-     * @param string $type        Chosen filesystem method.
-     * @param object $error       Error object.
-     * @param string $context     Full path to the directory that is tested
-     *                            for being writable.
+     * @param string[]      $types       Types of connections.
+     * @param array         $credentials Credentials to connect with.
+     * @param string        $type        Chosen filesystem method.
+     * @param WP_Error|bool $error       Error object or status.
+     * @param string        $context     Full path to the directory that is tested for being writable.
      */
     $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );