Changeset 47398 for trunk/src/wp-admin/includes/file.php

Timestamp:

03/01/2020 10:38:00 AM (5 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docs fixes and improvements.

See #48303.

File:

• trunk/src/wp-admin/includes/file.php (modified) (2 diffs)

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

@@ -1967 +1967 @@
  * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
  *
- * @return bool True on success, false on failure.
+ * @return bool|array True if no filesystem credentials are required, false if they are required but have not been
+ *                    provided, array of credentials if they are required and have been provided.
  */
 function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
@@ -1973 +1974 @@
 
     /**
-     * Filters the filesystem credentials form output.
+     * Filters the filesystem credentials.
      *
      * Returning anything other than an empty string will effectively short-circuit
      * output of the filesystem credentials form, returning that value instead.
      *
+     * A filter should return true if no filesystem credentials are required, false if they are required but have not been
+     * provided, or an array of credentials if they are required and have been provided.
+     *
      * @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.
+     * @param mixed         $credentials                  Credentials to return instead. Default empty string.
      * @param string        $form_post                    The URL to post the form to.
      * @param string        $type                         Chosen type of filesystem.