WordPress.org

Make WordPress Core


Ignore:
Timestamp:
01/11/2020 06:30:58 PM (13 months ago)
Author:
SergeyBiryukov
Message:

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

Follow-up to [46696].

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/file.php

    r47043 r47060  
    11901190 * @param string|array $signatures          A Signature provided for the file.
    11911191 * @param string       $filename_for_errors A friendly filename for errors. Optional.
    1192  *
    1193  * @return bool|WP_Error true on success, false if verification not attempted, or WP_Error describing an error condition.
     1192 * @return bool|WP_Error True on success, false if verification not attempted,
     1193 *                       or WP_Error describing an error condition.
    11941194 */
    11951195function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
     
    19651965     * @param string        $form_post                    The URL to post the form to.
    19661966     * @param string        $type                         Chosen type of filesystem.
    1967      * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
    1968      *                                                    or an error object. Default false.
     1967     * @param bool|WP_Error $error                        Whether the current request has failed to connect,
     1968     *                                                    or an error object.
    19691969     * @param string        $context                      Full path to the directory that is tested for
    19701970     *                                                    being writable.
    19711971     * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
    1972      *                                                    Default false.
    19731972     * @param array         $extra_fields                 Extra POST fields.
    19741973     */
     
    20932092     * @param array         $credentials Credentials to connect with.
    20942093     * @param string        $type        Chosen filesystem method.
    2095      * @param bool|WP_Error $error       Error object or status.
     2094     * @param bool|WP_Error $error       Whether the current request has failed to connect,
     2095     *                                   or an error object.
    20962096     * @param string        $context     Full path to the directory that is tested for being writable.
    20972097     */
Note: See TracChangeset for help on using the changeset viewer.