WordPress.org

Make WordPress Core

Changeset 37540


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

Docs: Apply inline @see tags to hooks referenced in DocBlocks in wp-includes/ms-functions.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/ms-functions.php

    r37511 r37540  
    139139
    140140/**
    141  * Add a user to a blog.
    142  *
    143  * Use the 'add_user_to_blog' action to fire an event when
    144  * users are added to a blog.
     141 * Adds a user to a blog.
     142 *
     143 * Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
    145144 *
    146145 * @since MU 1.0
     
    188187 * Remove a user from a blog.
    189188 *
    190  * Use the 'remove_user_from_blog' action to fire an event when
     189 * Use the {@see 'remove_user_from_blog'} action to fire an event when
    191190 * users are removed from a blog.
    192191 *
    193  * Accepts an optional $reassign parameter, if you want to
     192 * Accepts an optional `$reassign` parameter, if you want to
    194193 * reassign the user's blog posts to another user upon removal.
    195194 *
     
    528527 * effectively an override of this limitation.
    529528 *
    530  * Filter 'wpmu_validate_blog_signup' if you want to modify
     529 * Filter {@see 'wpmu_validate_blog_signup'} if you want to modify
    531530 * the way that WordPress validates new site signups.
    532531 *
     
    750749 * is enabled.
    751750 *
    752  * Filter 'wpmu_signup_blog_notification' to bypass this function or
     751 * Filter {@see 'wpmu_signup_blog_notification'} to bypass this function or
    753752 * replace it with your own notification behavior.
    754753 *
    755  * Filter 'wpmu_signup_blog_notification_email' and
    756  * 'wpmu_signup_blog_notification_subject' to change the content
     754 * Filter {@see 'wpmu_signup_blog_notification_email'} and
     755 * {@see 'wpmu_signup_blog_notification_subject'} to change the content
    757756 * and subject line of the email sent to newly registered users.
    758757 *
     
    856855 * been requested.
    857856 *
    858  * Filter 'wpmu_signup_user_notification' to bypass this function or
     857 * Filter {@see 'wpmu_signup_user_notification'} to bypass this function or
    859858 * replace it with your own notification behavior.
    860859 *
    861  * Filter 'wpmu_signup_user_notification_email' and
    862  * 'wpmu_signup_user_notification_subject' to change the content
     860 * Filter {@see 'wpmu_signup_user_notification_email'} and
     861 * {@see 'wpmu_signup_user_notification_subject'} to change the content
    863862 * and subject line of the email sent to newly registered users.
    864863 *
     
    938937 * Activate a signup.
    939938 *
    940  * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events
     939 * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
    941940 * that should happen only when users or sites are self-created (since
    942941 * those actions are not called when users and sites are created
     
    10331032 *
    10341033 * This function runs when a user self-registers as well as when
    1035  * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events
     1034 * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
    10361035 * that should affect all new users, but only on Multisite (otherwise
    1037  * use 'user_register').
     1036 * use {@see'user_register'}).
    10381037 *
    10391038 * @since MU
     
    10711070 *
    10721071 * This function runs when a user self-registers a new site as well
    1073  * as when a Super Admin creates a new site. Hook to 'wpmu_new_blog'
     1072 * as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'}
    10741073 * for events that should affect all new sites.
    10751074 *
     
    11551154 * Notifies the network admin that a new site has been activated.
    11561155 *
    1157  * Filter 'newblog_notify_siteadmin' to change the content of
     1156 * Filter {@see 'newblog_notify_siteadmin'} to change the content of
    11581157 * the notification email.
    11591158 *
     
    12011200 * Notifies the network admin that a new user has been activated.
    12021201 *
    1203  * Filter 'newuser_notify_siteadmin' to change the content of
     1202 * Filter {@see 'newuser_notify_siteadmin'} to change the content of
    12041203 * the notification email.
    12051204 *
     
    14031402 * Notify a user that their blog activation has been successful.
    14041403 *
    1405  * Filter 'wpmu_welcome_notification' to disable or bypass.
    1406  *
    1407  * Filter 'update_welcome_email' and 'update_welcome_subject' to
     1404 * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
     1405 *
     1406 * Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to
    14081407 * modify the content and subject line of the notification email.
    14091408 *
     
    15061505 * Notify a user that their account activation has been successful.
    15071506 *
    1508  * Filter 'wpmu_welcome_user_notification' to disable or bypass.
    1509  *
    1510  * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to
     1507 * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
     1508 *
     1509 * Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
    15111510 * modify the content and subject line of the notification email.
    15121511 *
     
    19991998
    20001999/**
    2001  * Add a newly created user to the appropriate blog
     2000 * Adds a newly created user to the appropriate blog
    20022001 *
    20032002 * To add a user in general, use add_user_to_blog(). This function
    2004  * is specifically hooked into the wpmu_activate_user action.
     2003 * is specifically hooked into the {@see 'wpmu_activate_user'} action.
    20052004 *
    20062005 * @since MU
     
    22012200 * Update the count of sites for the current network.
    22022201 *
    2203  * If enabled through the 'enable_live_network_counts' filter, update the sites count
     2202 * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
    22042203 * on a network when a site is created or its status is updated.
    22052204 *
     
    22282227 * Update the network-wide users count.
    22292228 *
    2230  * If enabled through the 'enable_live_network_counts' filter, update the users count
     2229 * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
    22312230 * on a network when a user is created or its status is updated.
    22322231 *
     
    23782377 *
    23792378 * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
    2380  * Plugins can alter this criteria using the 'wp_is_large_network' filter.
     2379 * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
    23812380 *
    23822381 * @since 3.3.0
Note: See TracChangeset for help on using the changeset viewer.