Make WordPress Core


Ignore:
Timestamp:
12/06/2014 09:23:52 PM (10 years ago)
Author:
DrewAPicture
Message:

Convert various uses of (optional) in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.

The style for marking parameters optional in inline PHP docs is: @param type $var Optional. Description. Accepts. Default., where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.

File:
1 edited

Legend:

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

    r30648 r30753  
    9898 * @since 2.6.0
    9999 *
    100  * @param string $folder Full path to folder
    101  * @param int $levels (optional) Levels of folders to follow, Default: 100 (PHP Loop limit).
     100 * @param string $folder Optional. Full path to folder. Default empty.
     101 * @param int    $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
    102102 * @return bool|array False on failure, Else array of files
    103103 */
     
    138138 * @since 2.6.0
    139139 *
    140  * @param string $filename (optional) Filename to base the Unique file off
    141  * @param string $dir (optional) Directory to store the file in
     140 * @param string $filename Optional. Filename to base the Unique file off. Default empty.
     141 * @param string $dir      Optional. Directory to store the file in. Default empty.
    142142 * @return string a writable filename
    143143 */
     
    806806 * This function will include the chosen transport and attempt connecting.
    807807 *
    808  * Plugins may add extra transports, And force WordPress to use them by returning the filename via the 'filesystem_method_file' filter.
     808 * Plugins may add extra transports, And force WordPress to use them by returning
     809 * the filename via the {@see 'filesystem_method_file'} filter.
    809810 *
    810811 * @since 2.5.0
    811812 *
    812  * @param array $args (optional) Connection args, These are passed directly to the WP_Filesystem_*() classes.
    813  * @param string $context (optional) Context for get_filesystem_method(), See function declaration for more information.
    814  * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
    815  * @return null|boolean false on failure, true on success
     813 * @param array  $args                         Optional. Connection args, These are passed directly to
     814 *                                             the `WP_Filesystem_*()` classes. Default false.
     815 * @param string $context                      Optional. Context for {@see get_filesystem_method()}.
     816 *                                             Default false.
     817 * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
     818 *                                             Default false.
     819 * @return null|boolean false on failure, true on success.
    816820 */
    817821function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
Note: See TracChangeset for help on using the changeset viewer.