Changeset 48432

Timestamp:

07/10/2020 11:26:31 PM (4 years ago)

Author:

whyisjake

Message:

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.

File:

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

trunk/src/wp-includes/formatting.php

@@ -2145 +2145 @@
 
 /**
- * Sanitizes a title, or returns a fallback title.
- *
- * 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
+ * Sanitizes a string into a slug, which can be used in places such as URLs or HTML attributes.
+ *
+ * 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.
  *