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.


git-svn-id: https://develop.svn.wordpress.org/trunk@40950 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2017-06-25 22:15:18 +00:00
parent 4a248fa9c2
commit 0624e59e02
1 changed files with 5 additions and 6 deletions

View File

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