IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Apply inline @see tags to hooks referenced in DocBlocks in a variety of wp-includes/* files.

Browse Source 
Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37511 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2016-05-23 19:01:27 +00:00
parent da78aeffe9
commit d28f1a08ef
10 changed files with 47 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
wp-includes/kses.php
View File

@@ -34,8 +34,9 @@
/**
* You can override this in a plugin.
*
* The wp_kses_allowed_html filter is more powerful and supplies context.
* CUSTOM_TAGS is not recommended and should be considered deprecated.
* The {@see 'wp_kses_allowed_html'} filter is more powerful and supplies context.
*
* `CUSTOM_TAGS` is not recommended and should be considered deprecated.
*
* @see wp_kses_allowed_html()
*
@@ -667,15 +668,15 @@ function wp_kses_allowed_html( $context = '' ) {
/**
* You add any kses hooks here.
*
* There is currently only one kses WordPress hook and it is called here. All
* parameters are passed to the hooks and expected to receive a string.
* There is currently only one kses WordPress hook, {@see 'pre_kses'}, and it is called here.
* All parameters are passed to the hooks and expected to receive a string.
*
* @since 1.0.0
*
* @param string $string Content to filter through kses
* @param array $allowed_html List of allowed HTML elements
* @param array $allowed_protocols Allowed protocol in links
* @return string Filtered content through 'pre_kses' hook
* @return string Filtered content through {@see 'pre_kses'} hook.
*/
function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
/**
@@ -1641,8 +1642,8 @@ function kses_init_filters() {
* A quick procedural method to removing all of the filters that kses uses for
* content in WordPress Loop.
*
* Does not remove the kses_init() function from 'init' hook (priority is
* default). Also does not remove kses_init() function from 'set_current_user'
* Does not remove the kses_init() function from {@see 'init'} hook (priority is
* default). Also does not remove kses_init() function from {@see 'set_current_user'}
* hook (priority is also default).
*
* @since 2.0.6
@@ -1664,8 +1665,8 @@ function kses_remove_filters() {
/**
* Sets up most of the Kses filters for input form content.
*
* If you remove the kses_init() function from 'init' hook and
* 'set_current_user' (priority is default), then none of the Kses filter hooks
* If you remove the kses_init() function from {@see 'init'} hook and
* {@see 'set_current_user'} (priority is default), then none of the Kses filter hooks
* will be added.
*
* First removes all of the Kses filters in case the current user does not need