Changeset 37536

Timestamp:

05/23/2016 05:06:40 PM (8 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:

• wp-activate.php (modified) (1 diff)
• wp-settings.php (modified) (1 diff)
• wp-signup.php (modified) (3 diffs)

trunk/src/wp-activate.php

@@ -33 +33 @@
 
 /**
- * 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
  */
 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

trunk/src/wp-settings.php

@@ -386 +386 @@
  *
  * 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.).
  *
- * 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

trunk/src/wp-signup.php

@@ -389 +389 @@
      * Filters the new site meta variables.
      *
+     * Use the {@see 'add_signup_meta'} filter instead.
+     *
      * @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.
@@ -431 +433 @@
  * @param string $user_name  The username.
  * @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.
  */
@@ -723 +725 @@
  * @param string $user_name The user's username
  * @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() ) {