Docs: Improve description for wp_unique_filename().

Props stevenlinx.
Fixes #50762.

git-svn-id: https://develop.svn.wordpress.org/trunk@48606 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-25 12:29:13 +00:00
parent 3127db3470
commit c8bb1f5cfd

View File

@ -2449,11 +2449,12 @@ function _wp_upload_dir( $time = null ) {
* Get a filename that is sanitized and unique for the given directory. * Get a filename that is sanitized and unique for the given directory.
* *
* If the filename is not unique, then a number will be added to the filename * If the filename is not unique, then a number will be added to the filename
* before the extension, and will continue adding numbers until the filename is * before the extension, and will continue adding numbers until the filename
* unique. * is unique.
* *
* The callback is passed three parameters, the first one is the directory, the * The callback function allows the caller to use their own method to create
* second is the filename, and the third is the extension. * unique file names. If defined, the callback should take three arguments:
* - directory, base filename, and extension - and return a unique filename.
* *
* @since 2.5.0 * @since 2.5.0
* *