Formatting: Improve the docblock for sanitize_title().

Since sanitize title is largely used for html attributes, or post slugs, make note that accents will be removed and that the string will be limited to alphanumeric characters, underscores, and dashes.

Fixes #33756.
Props ericlewis, swissspidy, wonderboymusic, psdtohtmlguru, DrewAPicture, SergeyBiryukov, sjmur, gma992, shulard, ebinnion, whyisjake.


Built from https://develop.svn.wordpress.org/trunk@48432


git-svn-id: http://core.svn.wordpress.org/trunk@48201 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
whyisjake 2020-07-10 23:28:04 +00:00
parent 5e4d204023
commit 919729508c
2 changed files with 5 additions and 4 deletions

View File

@ -2144,10 +2144,11 @@ function sanitize_key( $key ) {
}
/**
* Sanitizes a title, or returns a fallback title.
* Sanitizes a string into a slug, which can be used in places such as URLs or HTML attributes.
*
* Specifically, HTML and PHP tags are stripped. Further actions can be added
* via the plugin API. If $title is empty and $fallback_title is set, the latter
* In a save context, converts accents to ASCII characters. By default, output is
* further limited to alphanumeric characters, underscore (_) and dash (-) through the
* 'sanitize_title' filter. If $title is empty and $fallback_title is set, the latter
* will be used.
*
* @since 1.0.0

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.5-beta1-48431';
$wp_version = '5.5-beta1-48432';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.