WordPress.org

Make WordPress Core

Changeset 37541


Ignore:
Timestamp:
05/23/2016 06:56:06 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Apply inline @see tags to hooks referenced in DocBlocks in wp-includes/general-template.php.

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

See #36921.

File:
1 edited

Legend:

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

    r37530 r37541  
    175175 * will be displayed. The default search form is HTML, which will be displayed.
    176176 * There is a filter applied to the search form HTML in order to edit or replace
    177  * it. The filter is 'get_search_form'.
     177 * it. The filter is {@see 'get_search_form'}.
    178178 *
    179179 * This function is primarily used by themes which want to hardcode the search
     
    181181 *
    182182 * There is also an action that is called whenever the function is run called,
    183  * 'pre_get_search_form'. This can be useful for outputting JavaScript that the
     183 * {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the
    184184 * search relies on or various formatting that applies to the beginning of the
    185185 * search. To give a few examples of what it can be used for.
     
    567567 * Theme container function for the 'wp_meta' action.
    568568 *
    569  * The 'wp_meta' action can have several purposes, depending on how you use it,
     569 * The {@see 'wp_meta'} action can have several purposes, depending on how you use it,
    570570 * but one purpose might have been to allow for theme switching.
    571571 *
     
    21812181 *
    21822182 * Unlike the_date() this function will always return the date.
    2183  * Modify output with 'get_the_date' filter.
     2183 * Modify output with the {@see 'get_the_date'} filter.
    21842184 *
    21852185 * @since 3.0.0
     
    25162516
    25172517/**
    2518  * Fire the wp_head action
     2518 * Fire the wp_head action.
     2519 *
     2520 * See {@see 'wp_head'}.
    25192521 *
    25202522 * @since 1.2.0
     
    25302532
    25312533/**
    2532  * Fire the wp_footer action
     2534 * Fire the wp_footer action.
     2535 *
     2536 * See {@see 'wp_footer'}.
    25332537 *
    25342538 * @since 1.5.1
     
    26932697
    26942698/**
    2695  * Display a noindex meta tag if required by the blog configuration.
     2699 * Displays a noindex meta tag if required by the blog configuration.
    26962700 *
    26972701 * If a blog is marked as not being public then the noindex meta tag will be
    2698  * output to tell web robots not to index the page content. Add this to the wp_head action.
    2699  * Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );
     2702 * output to tell web robots not to index the page content. Add this to the
     2703 * {@see 'wp_head'} action.
     2704 *
     2705 * Typical usage is as a {@see 'wp_head'} callback:
     2706 *
     2707 *     add_action( 'wp_head', 'noindex' );
    27002708 *
    27012709 * @see wp_no_robots
     
    32733281
    32743282/**
    3275  * Display the URL of a WordPress admin CSS file.
    3276  *
    3277  * @see WP_Styles::_css_href and its style_loader_src filter.
     3283 * Displays the URL of a WordPress admin CSS file.
     3284 *
     3285 * @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.
    32783286 *
    32793287 * @since 2.3.0
     
    33053313 *
    33063314 * "Intelligently" decides to enqueue or to print the CSS file. If the
    3307  * 'wp_print_styles' action has *not* yet been called, the CSS file will be
    3308  * enqueued. If the wp_print_styles action *has* been called, the CSS link will
     3315 * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be
     3316 * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will
    33093317 * be printed. Printing may be forced by passing true as the $force_echo
    33103318 * (second) parameter.
     
    33703378
    33713379/**
    3372  * Display the XHTML generator that is generated on the wp_head hook.
     3380 * Displays the XHTML generator that is generated on the wp_head hook.
     3381 *
     3382 * See {@see 'wp_head'}.
    33733383 *
    33743384 * @since 2.5.0
     
    33893399 *
    33903400 * Returns the correct generator type for the requested output format. Allows
    3391  * for a plugin to filter generators overall the the_generator filter.
     3401 * for a plugin to filter generators overall the {@see 'the_generator'} filter.
    33923402 *
    33933403 * @since 2.5.0
     
    34133423 * Returns the correct generator type for the requested output format. Allows
    34143424 * for a plugin to filter generators on an individual basis using the
    3415  * 'get_the_generator_{$type}' filter.
     3425 * {@see 'get_the_generator_$type'} filter.
    34163426 *
    34173427 * @since 2.5.0
Note: See TracChangeset for help on using the changeset viewer.