sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Formatting: Rename the `$richedit` parameter in `format_to_edit()` to `$rich_text`. 

Previously, it was necessary to explain in a double-negative that `$richedit` being false would prevent `$content` from being passed through `esc_textarea()`. The updated `$rich_edit` name and documentation now better reflects the intent of the parameter.

Fixes #21613.


git-svn-id: https://develop.svn.wordpress.org/trunk@34727 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-01 02:00:42 +00:00
parent f737a197c2
commit ed1240234d
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wp-includes/formatting.php
View File

@ -1843,12 +1843,15 @@ function force_balance_tags( $text ) {
* it is simply a holder for the 'format_to_edit' filter.
*
* @since 0.71
* @since 4.4.0 The `$richedit` parameter was renamed to `$rich_text` for clarity.
*
* @param string $content The text about to be edited.
* @param bool $richedit Whether the $content should not pass through htmlspecialchars(). Default false (meaning it will be passed).
* @param string $content The text about to be edited.
* @param bool $rich_text Optional. Whether `$content` should be considered rich text,
* in which case it would not be passed through esc_textarea().
* Default false.
* @return string The text after the filter (and possibly htmlspecialchars()) has been run.
*/
function format_to_edit( $content, $richedit = false ) {
function format_to_edit( $content, $rich_text = false ) {
/**
* Filter the text to be formatted for editing.
*
@ -1857,7 +1860,7 @@ function format_to_edit( $content, $richedit = false ) {
* @param string $content The text, prior to formatting for editing.
*/
$content = apply_filters( 'format_to_edit', $content );
if ( ! $richedit )
if ( ! $rich_text )
$content = esc_textarea( $content );
return $content;
}