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.

Fixes #36921.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37512 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2016-05-23 19:02:28 +00:00
parent d28f1a08ef
commit 9193013158
17 changed files with 48 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
wp-includes/widgets.php
View File

@@ -114,10 +114,10 @@ function register_widget($widget_class) {
}
/**
* Unregister a widget
* Unregisters a widget.
*
* Unregisters a WP_Widget widget. Useful for unregistering default widgets.
* Run within a function hooked to the widgets_init action.
* Unregisters a WP_Widget widget. Useful for un-registering default widgets.
* Run within a function hooked to the {@see 'widgets_init'} action.
*
* @since 2.8.0
*
@@ -125,7 +125,7 @@ function register_widget($widget_class) {
*
* @global WP_Widget_Factory $wp_widget_factory
*
* @param string $widget_class The name of a class that extends WP_Widget
* @param string $widget_class The name of a class that extends WP_Widget.
*/
function unregister_widget($widget_class) {
global $wp_widget_factory;
@@ -780,7 +780,7 @@ function dynamic_sidebar( $index = 1 ) {
* the widget with that callback/$id_base AND that ID is found.
*
* NOTE: $widget_id and $id_base are the same for single widgets. To be effective
* this function has to run after widgets have initialized, at action 'init' or later.
* this function has to run after widgets have initialized, at action {@see 'init'} or later.
*
* @since 2.2.0
*
@@ -1429,10 +1429,9 @@ function wp_widget_rss_process( $widget_rss, $check_feed = true ) {
}
/**
* Register all of the default WordPress widgets on startup.
* Registers all of the default WordPress widgets on startup.
*
* Calls 'widgets_init' action after all of the WordPress widgets have been
* registered.
* Calls {@see 'widgets_init'} action after all of the WordPress widgets have been registered.
*
* @since 2.2.0
*/