WordPress.org

Make WordPress Core

Changeset 46597


Ignore:
Timestamp:
10/26/2019 11:14:59 PM (13 months ago)
Author:
johnbillion
Message:

Docs: Update the docs for the error parameter that gets passed around during filesystem credential collection.

See #48303

Location:
trunk/src/wp-admin/includes
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

    r46125 r46597  
    3131     * @see request_filesystem_credentials()
    3232     *
    33      * @param bool   $error                        Optional. Whether the current request has failed to connect.
    34      *                                             Default false.
    35      * @param string $context                      Optional. Full path to the directory that is tested
    36      *                                             for being writable. Default empty.
    37      * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
     33     * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
     34     *                                                    or an error object. Default false.
     35     * @param string        $context                      Optional. Full path to the directory that is tested
     36     *                                                    for being writable. Default empty.
     37     * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
    3838     * @return bool True on success, false on failure.
    3939     */
  • trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

    r46125 r46597  
    7777     * @see request_filesystem_credentials()
    7878     *
    79      * @param bool   $error                        Optional. Whether the current request has failed to connect.
    80      *                                             Default false.
    81      * @param string $context                      Optional. Full path to the directory that is tested
    82      *                                             for being writable. Default empty.
    83      * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
     79     * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
     80     *                                                    or an error object. Default false.
     81     * @param string        $context                      Optional. Full path to the directory that is tested
     82     *                                                    for being writable. Default empty.
     83     * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
    8484     * @return bool False on failure, true on success.
    8585     */
  • trunk/src/wp-admin/includes/file.php

    r46596 r46597  
    19321932 * @global string $pagenow
    19331933 *
    1934  * @param string $form_post                    The URL to post the form to.
    1935  * @param string $type                         Optional. Chosen type of filesystem. Default empty.
    1936  * @param bool   $error                        Optional. Whether the current request has failed to connect.
    1937  *                                             Default false.
    1938  * @param string $context                      Optional. Full path to the directory that is tested for being
    1939  *                                             writable. Default empty.
    1940  * @param array  $extra_fields                 Optional. Extra `POST` fields to be checked for inclusion in
    1941  *                                             the post. Default null.
    1942  * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
     1934 * @param string        $form_post                    The URL to post the form to.
     1935 * @param string        $type                         Optional. Chosen type of filesystem. Default empty.
     1936 * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
     1937 *                                                    or an error object. Default false.
     1938 * @param string        $context                      Optional. Full path to the directory that is tested for being
     1939 *                                                    writable. Default empty.
     1940 * @param array         $extra_fields                 Optional. Extra `POST` fields to be checked for inclusion in
     1941 *                                                    the post. Default null.
     1942 * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
    19431943 *
    19441944 * @return bool True on success, false on failure.
     
    19561956     * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
    19571957     *
    1958      * @param mixed  $output                       Form output to return instead. Default empty.
    1959      * @param string $form_post                    The URL to post the form to.
    1960      * @param string $type                         Chosen type of filesystem.
    1961      * @param bool   $error                        Whether the current request has failed to connect.
    1962      *                                             Default false.
    1963      * @param string $context                      Full path to the directory that is tested for
    1964      *                                             being writable.
    1965      * @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
    1966      *                                             Default false.
    1967      * @param array  $extra_fields                 Extra POST fields.
     1958     * @param mixed         $output                       Form output to return instead. Default empty.
     1959     * @param string        $form_post                    The URL to post the form to.
     1960     * @param string        $type                         Chosen type of filesystem.
     1961     * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
     1962     *                                                    or an error object. Default false.
     1963     * @param string        $context                      Full path to the directory that is tested for
     1964     *                                                    being writable.
     1965     * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
     1966     *                                                    Default false.
     1967     * @param array         $extra_fields                 Extra POST fields.
    19681968     */
    19691969    $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
     
    20842084     * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
    20852085     *
    2086      * @param array  $types       Types of connections.
    2087      * @param array  $credentials Credentials to connect with.
    2088      * @param string $type        Chosen filesystem method.
    2089      * @param object $error       Error object.
    2090      * @param string $context     Full path to the directory that is tested
    2091      *                            for being writable.
     2086     * @param string[]      $types       Types of connections.
     2087     * @param array         $credentials Credentials to connect with.
     2088     * @param string        $type        Chosen filesystem method.
     2089     * @param WP_Error|bool $error       Error object or status.
     2090     * @param string        $context     Full path to the directory that is tested for being writable.
    20922091     */
    20932092    $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );
Note: See TracChangeset for help on using the changeset viewer.