Changeset 49484

Timestamp:

11/02/2020 08:18:12 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update description for the $context parameter of sanitize_title() and sanitize_title_with_dashes().

This brings some consistency between the two DocBlocks and adjusts the latter one per the documentation standards.

Follow-up to [49482].

See #50569.

File:

• trunk/src/wp-includes/formatting.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -2165 +2165 @@
  * @param string $fallback_title Optional. A title to use if $title is empty. Default empty.
  * @param string $context        Optional. The operation for which the string is sanitized.
+ *                               When set to 'save', the string runs through remove_accents().
  *                               Default 'save'.
  * @return string The sanitized string.
@@ -2217 +2218 @@
  * @param string $title     The title to be sanitized.
  * @param string $raw_title Optional. Not used. Default empty.
- * @param string $context   Optional. The context for the sanitization. When set to 'save', additional entities are converted to hyphens or stripped entirely.
- *                          Default 'display'.
+ * @param string $context   Optional. The operation for which the string is sanitized.
+ *                          When set to 'save', additional entities are converted to hyphens
+ *                          or stripped entirely. Default 'display'.
  * @return string The sanitized title.
  */