WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/23/2016 07:01:40 PM (4 years ago)
Author:
DrewAPicture
Message:

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

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

Fixes #36921.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/widgets.php

    r37518 r37544  
    115115
    116116/**
    117  * Unregister a widget
    118  *
    119  * Unregisters a WP_Widget widget. Useful for unregistering default widgets.
    120  * Run within a function hooked to the widgets_init action.
     117 * Unregisters a widget.
     118 *
     119 * Unregisters a WP_Widget widget. Useful for un-registering default widgets.
     120 * Run within a function hooked to the {@see 'widgets_init'} action.
    121121 *
    122122 * @since 2.8.0
     
    126126 * @global WP_Widget_Factory $wp_widget_factory
    127127 *
    128  * @param string $widget_class The name of a class that extends WP_Widget
     128 * @param string $widget_class The name of a class that extends WP_Widget.
    129129 */
    130130function unregister_widget($widget_class) {
     
    781781 *
    782782 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
    783  * this function has to run after widgets have initialized, at action 'init' or later.
     783 * this function has to run after widgets have initialized, at action {@see 'init'} or later.
    784784 *
    785785 * @since 2.2.0
     
    14301430
    14311431/**
    1432  * Register all of the default WordPress widgets on startup.
    1433  *
    1434  * Calls 'widgets_init' action after all of the WordPress widgets have been
    1435  * registered.
     1432 * Registers all of the default WordPress widgets on startup.
     1433 *
     1434 * Calls {@see 'widgets_init'} action after all of the WordPress widgets have been registered.
    14361435 *
    14371436 * @since 2.2.0
Note: See TracChangeset for help on using the changeset viewer.