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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37504 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-23 17:07:28 +00:00
parent f82641ad0e
commit e52762a725
4 changed files with 15 additions and 9 deletions

View File

@ -32,13 +32,17 @@ $wp_query->is_404 = false;
do_action( 'activate_header' ); do_action( 'activate_header' );
/** /**
* Adds an action hook specific to this page that fires on wp_head * Adds an action hook specific to this page.
*
* Fires on {@see 'wp_head'}.
* *
* @since MU * @since MU
*/ */
function do_activate_header() { function do_activate_header() {
/** /**
* Fires before the Site Activation page is loaded, but on the wp_head action. * Fires before the Site Activation page is loaded.
*
* Fires on the {@see 'wp_head'} action.
* *
* @since 3.0.0 * @since 3.0.0
*/ */

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.6-alpha-37535'; $wp_version = '4.6-alpha-37536';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -385,10 +385,10 @@ $GLOBALS['wp']->init();
* Fires after WordPress has finished loading but before any headers are sent. * Fires after WordPress has finished loading but before any headers are sent.
* *
* Most of WP is loaded at this stage, and the user is authenticated. WP continues * Most of WP is loaded at this stage, and the user is authenticated. WP continues
* to load on the init hook that follows (e.g. widgets), and many plugins instantiate * to load on the {@see 'init'} hook that follows (e.g. widgets), and many plugins instantiate
* themselves on it for all sorts of reasons (e.g. they need a user, a taxonomy, etc.). * themselves on it for all sorts of reasons (e.g. they need a user, a taxonomy, etc.).
* *
* If you wish to plug an action once WP is loaded, use the wp_loaded hook below. * If you wish to plug an action once WP is loaded, use the {@see 'wp_loaded'} hook below.
* *
* @since 1.5.0 * @since 1.5.0
*/ */

View File

@ -388,8 +388,10 @@ function validate_another_blog_signup() {
/** /**
* Filters the new site meta variables. * Filters the new site meta variables.
* *
* Use the {@see 'add_signup_meta'} filter instead.
*
* @since MU * @since MU
* @deprecated 3.0.0 Use the 'add_signup_meta' filter instead. * @deprecated 3.0.0 Use the {@see 'add_signup_meta'} filter instead.
* *
* @param array $blog_meta_defaults An array of default blog meta variables. * @param array $blog_meta_defaults An array of default blog meta variables.
*/ */
@ -430,7 +432,7 @@ function validate_another_blog_signup() {
* @param string $blog_title The site title. * @param string $blog_title The site title.
* @param string $user_name The username. * @param string $user_name The username.
* @param string $user_email The user's email address. * @param string $user_email The user's email address.
* @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup(). * @param array $meta Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup().
* @param int $blog_id The site ID. * @param int $blog_id The site ID.
*/ */
function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array(), $blog_id = 0 ) { function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array(), $blog_id = 0 ) {
@ -722,7 +724,7 @@ function validate_blog_signup() {
* @param string $blog_title The new site title * @param string $blog_title The new site title
* @param string $user_name The user's username * @param string $user_name The user's username
* @param string $user_email The user's email address * @param string $user_email The user's email address
* @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup() * @param array $meta Any additional meta from the {@see 'add_signup_meta'} filter in validate_blog_signup()
*/ */
function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $user_email = '', $meta = array() ) { function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $user_email = '', $meta = array() ) {
?> ?>