WordPress.org

Make WordPress Core

Changeset 37536


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

Docs: Apply inline @see tags to hooks referenced in DocBlocks for root directory files.

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

See #36921.

Location:
trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-activate.php

    r36416 r37536  
    3333
    3434/**
    35  * Adds an action hook specific to this page that fires on wp_head
     35 * Adds an action hook specific to this page.
     36 *
     37 * Fires on {@see 'wp_head'}.
    3638 *
    3739 * @since MU
    3840 */
    3941function do_activate_header() {
    40     /**
    41      * Fires before the Site Activation page is loaded, but on the wp_head action.
     42    /**
     43     * Fires before the Site Activation page is loaded.
     44     *
     45     * Fires on the {@see 'wp_head'} action.
    4246     *
    4347     * @since 3.0.0
  • trunk/src/wp-settings.php

    r37477 r37536  
    386386 *
    387387 * Most of WP is loaded at this stage, and the user is authenticated. WP continues
    388  * to load on the init hook that follows (e.g. widgets), and many plugins instantiate
     388 * to load on the {@see 'init'} hook that follows (e.g. widgets), and many plugins instantiate
    389389 * themselves on it for all sorts of reasons (e.g. they need a user, a taxonomy, etc.).
    390390 *
    391  * If you wish to plug an action once WP is loaded, use the wp_loaded hook below.
     391 * If you wish to plug an action once WP is loaded, use the {@see 'wp_loaded'} hook below.
    392392 *
    393393 * @since 1.5.0
  • trunk/src/wp-signup.php

    r37535 r37536  
    389389     * Filters the new site meta variables.
    390390     *
     391     * Use the {@see 'add_signup_meta'} filter instead.
     392     *
    391393     * @since MU
    392      * @deprecated 3.0.0 Use the 'add_signup_meta' filter instead.
     394     * @deprecated 3.0.0 Use the {@see 'add_signup_meta'} filter instead.
    393395     *
    394396     * @param array $blog_meta_defaults An array of default blog meta variables.
     
    431433 * @param string $user_name  The username.
    432434 * @param string $user_email The user's email address.
    433  * @param array  $meta       Any additional meta from the 'add_signup_meta' filter in validate_blog_signup().
     435 * @param array  $meta       Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup().
    434436 * @param int    $blog_id    The site ID.
    435437 */
     
    723725 * @param string $user_name The user's username
    724726 * @param string $user_email The user's email address
    725  * @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
     727 * @param array $meta Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup()
    726728 */
    727729function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $user_email = '', $meta = array() ) {
Note: See TracChangeset for help on using the changeset viewer.