Changeset 57907

Timestamp:

04/01/2024 04:53:25 PM (6 months ago)

Author:

audrasjb

Message:

Docs: Improve the docblock for _wp_filter_font_directory().

Removes the recommended use section as this is a private use only function.

Reviewed by davidbaumwald.
Merges [57902] to the 6.5 branch.
Props peterwilsoncc, swissspidy, azaozz.
Fixes #60652.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• src/wp-includes/fonts.php (modified) (1 diff)

branches/6.5/src/wp-includes/fonts.php

@@ -141 +141 @@
 
 /**
- * Returns the font directory for use by the font library.
- *
- * This function is a callback for the {@see 'upload_dir'} filter. It is not
- * intended to be called directly. Use wp_get_font_dir() instead.
- *
- * The function can be used when extending the font library to modify the upload
- * destination for font files via the upload_dir filter. The recommended way to
- * do this is:
- *
- * ```php
- * add_filter( 'upload_dir', '_wp_filter_font_directory' );
- * // Your code to upload or sideload a font file.
- * remove_filter( 'upload_dir', '_wp_filter_font_directory' );
- * ```
+ * A callback function for use in the {@see 'upload_dir'} filter.
+ *
+ * This function is intended for internal use only and should not be used by plugins and themes.
+ * Use wp_get_font_dir() instead.
  *
  * @since 6.5.0