Changeset 48606 for trunk/src/wp-includes/functions.php

Timestamp:

07/25/2020 12:29:13 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve description for wp_unique_filename().

Props stevenlinx.
Fixes #50762.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -2450 +2450 @@
  *
  * 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
- * unique.
- *
- * The callback is passed three parameters, the first one is the directory, the
- * second is the filename, and the third is the extension.
+ * before the extension, and will continue adding numbers until the filename
+ * is unique.
+ *
+ * The callback function allows the caller to use their own method to create
+ * 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