WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
Built from https://develop.svn.wordpress.org/trunk@49484


git-svn-id: http://core.svn.wordpress.org/trunk@49243 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-11-02 20:20:07 +00:00
parent a3581edd84
commit 1543954adc
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-includes/formatting.php
View File

@ -2164,6 +2164,7 @@ function sanitize_key( $key ) {
* @param string $title The string to be sanitized. * @param string $title The string to be sanitized.
* @param string $fallback_title Optional. A title to use if $title is empty. Default empty. * @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. * @param string $context Optional. The operation for which the string is sanitized.
* When set to 'save', the string runs through remove_accents().
* Default 'save'. * Default 'save'.
* @return string The sanitized string. * @return string The sanitized string.
*/ */
@ -2216,8 +2217,9 @@ function sanitize_title_for_query( $title ) {
* *
* @param string $title The title to be sanitized. * @param string $title The title to be sanitized.
* @param string $raw_title Optional. Not used. Default empty. * @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. * @param string $context Optional. The operation for which the string is sanitized.
* Default 'display'. * When set to 'save', additional entities are converted to hyphens
* or stripped entirely. Default 'display'.
* @return string The sanitized title. * @return string The sanitized title.
*/ */
function sanitize_title_with_dashes( $title, $raw_title = '', $context = 'display' ) { function sanitize_title_with_dashes( $title, $raw_title = '', $context = 'display' ) {

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.6-beta2-49483'; $wp_version = '5.6-beta2-49484';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.