WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/01/2020 10:38:00 AM (16 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docs fixes and improvements.

See #48303.

File:
1 edited

Legend:

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

    r47396 r47398  
    19671967 * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
    19681968 *
    1969  * @return bool True on success, false on failure.
     1969 * @return bool|array True if no filesystem credentials are required, false if they are required but have not been
     1970 *                    provided, array of credentials if they are required and have been provided.
    19701971 */
    19711972function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
     
    19731974
    19741975    /**
    1975      * Filters the filesystem credentials form output.
     1976     * Filters the filesystem credentials.
    19761977     *
    19771978     * Returning anything other than an empty string will effectively short-circuit
    19781979     * output of the filesystem credentials form, returning that value instead.
    19791980     *
     1981     * A filter should return true if no filesystem credentials are required, false if they are required but have not been
     1982     * provided, or an array of credentials if they are required and have been provided.
     1983     *
    19801984     * @since 2.5.0
    19811985     * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
    19821986     *
    1983      * @param mixed         $output                       Form output to return instead. Default empty.
     1987     * @param mixed         $credentials                  Credentials to return instead. Default empty string.
    19841988     * @param string        $form_post                    The URL to post the form to.
    19851989     * @param string        $type                         Chosen type of filesystem.
Note: See TracChangeset for help on using the changeset viewer.