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

Timestamp:

01/11/2020 06:30:58 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

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

@@ -1190 +1190 @@
  * @param string|array $signatures          A Signature provided for the file.
  * @param string       $filename_for_errors A friendly filename for errors. Optional.
- *
- * @return bool|WP_Error true on success, false if verification not attempted, or WP_Error describing an error condition.
+ * @return bool|WP_Error True on success, false if verification not attempted,
+ *                       or WP_Error describing an error condition.
  */
 function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
@@ -1965 +1965 @@
      * @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 bool|WP_Error $error                        Whether the current request has failed to connect,
+     *                                                    or an error object.
      * @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.
      */
@@ -2093 +2092 @@
      * @param array         $credentials Credentials to connect with.
      * @param string        $type        Chosen filesystem method.
-     * @param bool|WP_Error $error       Error object or status.
+     * @param bool|WP_Error $error       Whether the current request has failed to connect,
+     *                                   or an error object.
      * @param string        $context     Full path to the directory that is tested for being writable.
      */