WordPress.org

Make WordPress Core

Changeset 47398


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

Docs: Miscellaneous docs fixes and improvements.

See #48303.

Location:
trunk/src
Files:
4 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.
  • trunk/src/wp-admin/includes/post.php

    r47397 r47398  
    19681968/**
    19691969 * Redirect to previous page.
     1970 *
     1971 * @since 2.7.0
    19701972 *
    19711973 * @param int $post_id Optional. Post ID.
  • trunk/src/wp-includes/functions.php

    r47397 r47398  
    26412641     * Filters whether to treat the upload bits as an error.
    26422642     *
    2643      * Passing a non-array to the filter will effectively short-circuit preparing
    2644      * the upload bits, returning that value instead.
     2643     * Returning a non-array from the filter will effectively short-circuit preparing the upload
     2644     * bits, returning that value instead. An error message should be returned as a string.
    26452645     *
    26462646     * @since 3.0.0
  • trunk/src/wp-includes/pluggable.php

    r47397 r47398  
    856856        }
    857857
    858         // Front-end cookie is secure when the auth cookie is secure and the site's home URL is forced HTTPS.
     858        // Front-end cookie is secure when the auth cookie is secure and the site's home URL uses HTTPS.
    859859        $secure_logged_in_cookie = $secure && 'https' === parse_url( get_option( 'home' ), PHP_URL_SCHEME );
    860860
    861861        /**
    862          * Filters whether the connection is secure.
     862         * Filters whether the auth cookie should only be sent over HTTPS.
    863863         *
    864864         * @since 3.1.0
    865865         *
    866          * @param bool $secure  Whether the connection is secure.
     866         * @param bool $secure  Whether the cookie should only be sent over HTTPS.
    867867         * @param int  $user_id User ID.
    868868         */
     
    870870
    871871        /**
    872          * Filters whether to use a secure cookie when logged-in.
     872         * Filters whether the logged in cookie should only be sent over HTTPS.
    873873         *
    874874         * @since 3.1.0
    875875         *
    876          * @param bool $secure_logged_in_cookie Whether to use a secure cookie when logged-in.
     876         * @param bool $secure_logged_in_cookie Whether the logged in cookie should only be sent over HTTPS.
    877877         * @param int  $user_id                 User ID.
    878          * @param bool $secure                  Whether the connection is secure.
     878         * @param bool $secure                  Whether the auth cookie should only be sent over HTTPS.
    879879         */
    880880        $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', $secure_logged_in_cookie, $user_id, $secure );
Note: See TracChangeset for help on using the changeset viewer.