Docs: Adjust notation for the $context parameter in the DocBlocks for the wp_kses_allowed_html() function and its associated wp_kses_allowed_html filter.

`$context|$allowedtags` can be either a string or array.

Props bor0.
Fixes #40575.

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


git-svn-id: http://core.svn.wordpress.org/trunk@40800 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-06-25 22:16:40 +00:00
parent 75acd01f98
commit 474711aac1
2 changed files with 6 additions and 7 deletions

View File

@ -615,9 +615,9 @@ function wp_kses_one_attr( $string, $element ) {
* @global array $allowedtags * @global array $allowedtags
* @global array $allowedentitynames * @global array $allowedentitynames
* *
* @param string $context The context for which to retrieve tags. * @param string|array $context The context for which to retrieve tags.
* Allowed values are post, strip, data,entities, or * Allowed values are post, strip, data, entities, or
* the name of a field filter such as pre_user_description. * the name of a field filter such as pre_user_description.
* @return array List of allowed tags and their allowed attributes. * @return array List of allowed tags and their allowed attributes.
*/ */
function wp_kses_allowed_html( $context = '' ) { function wp_kses_allowed_html( $context = '' ) {
@ -629,9 +629,8 @@ function wp_kses_allowed_html( $context = '' ) {
* *
* @since 3.5.0 * @since 3.5.0
* *
* @param string $tags Allowed tags, attributes, and/or entities. * @param array $context Context to judge allowed tags by.
* @param string $context Context to judge allowed tags by. Allowed values are 'post', * @param string $context_type Context type (explicit).
* 'data', 'strip', 'entities', 'explicit', or the name of a filter.
*/ */
return apply_filters( 'wp_kses_allowed_html', $context, 'explicit' ); return apply_filters( 'wp_kses_allowed_html', $context, 'explicit' );
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-40949'; $wp_version = '4.9-alpha-40950';
/** /**
* 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.