Docs: Improve DocBlock syntax for `wp_get_upload_dir()`, introduced in [36565].

See #34359. See #35986.


git-svn-id: https://develop.svn.wordpress.org/trunk@36925 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-10 03:37:43 +00:00
parent 47dd0e3471
commit 89cfbe98f1
1 changed files with 5 additions and 2 deletions

View File

@ -1802,13 +1802,16 @@ function win_is_writable( $path ) {
}
/**
* Get uploads directory information.
* Retrieves uploads directory information.
*
* Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory.
* Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases when not uploading files.
* Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases
* when not uploading files.
*
* @since 4.5.0
*
* @see wp_upload_dir()
*
* @return array See wp_upload_dir() for description.
*/
function wp_get_upload_dir() {