Make WordPress Core


Ignore:
Timestamp:
08/01/2017 08:43:25 PM (8 years ago)
Author:
DrewAPicture
Message:

Docs: Reduce confusion in @since MU notationss by indicating the WP version (3.0.0) the code was merged into core while retaining the original context.

Props sathyapulse.
Fixes #41509.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-functions.php

    r41164 r41200  
    1111 * Gets the network's site and user counts.
    1212 *
    13  * @since MU 1.0
     13 * @since MU (3.0.0) 1.0
    1414 *
    1515 * @return array Site and user count for the network.
     
    3333 * is returned.
    3434 *
    35  * @since MU 1.0
     35 * @since MU (3.0.0) 1.0
    3636 *
    3737 * @global wpdb $wpdb WordPress database abstraction object.
     
    9696 * The count is cached and updated twice daily. This is not a live count.
    9797 *
    98  * @since MU 2.7
     98 * @since MU (3.0.0) 2.7
    9999 * @since 4.8.0 The $network_id parameter has been added.
    100100 *
     
    111111 * The count is cached and updated twice daily. This is not a live count.
    112112 *
    113  * @since MU 1.0
     113 * @since MU (3.0.0) 1.0
    114114 * @since 3.7.0 The $network_id parameter has been deprecated.
    115115 * @since 4.8.0 The $network_id parameter is now being used.
     
    125125 * Get a blog post from any site on the network.
    126126 *
    127  * @since MU 1.0
     127 * @since MU (3.0.0) 1.0
    128128 *
    129129 * @param int $blog_id ID of the blog.
     
    144144 * Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
    145145 *
    146  * @since MU 1.0
     146 * @since MU (3.0.0) 1.0
    147147 *
    148148 * @param int    $blog_id ID of the blog you're adding the user to.
     
    172172     * Fires immediately after a user is added to a site.
    173173     *
    174      * @since MU
     174     * @since MU (3.0.0)
    175175     *
    176176     * @param int    $user_id User ID.
     
    194194 * reassign the user's blog posts to another user upon removal.
    195195 *
    196  * @since MU 1.0
     196 * @since MU (3.0.0) 1.0
    197197 *
    198198 * @global wpdb $wpdb WordPress database abstraction object.
     
    210210     * Fires before a user is removed from a site.
    211211     *
    212      * @since MU
     212     * @since MU (3.0.0)
    213213     *
    214214     * @param int $user_id User ID.
     
    275275 * Get the permalink for a post on another blog.
    276276 *
    277  * @since MU 1.0
     277 * @since MU (3.0.0) 1.0
    278278 *
    279279 * @param int $blog_id ID of the source blog.
     
    297297 * $domain is 'blog1.example.com' and $path is '/'.
    298298 *
    299  * @since MU 2.6.5
     299 * @since MU (3.0.0) 2.6.5
    300300 *
    301301 * @global wpdb $wpdb WordPress database abstraction object.
     
    343343 * bypasses this check.
    344344 *
    345  * @since MU
     345 * @since MU (3.0.0)
    346346 *
    347347 * @param string $user_email The email provided by the user at registration.
     
    401401 * necessary.
    402402 *
    403  * @since MU
     403 * @since MU (3.0.0)
    404404 *
    405405 * @global wpdb $wpdb WordPress database abstraction object.
     
    507507     * registration. The values are solely used for validation and error handling.
    508508     *
    509      * @since MU
     509     * @since MU (3.0.0)
    510510     *
    511511     * @param array $result {
     
    535535 * the way that WordPress validates new site signups.
    536536 *
    537  * @since MU
     537 * @since MU (3.0.0)
    538538 *
    539539 * @global wpdb   $wpdb
     
    606606     * path depending on the network settings.
    607607     *
    608      * @since MU
     608     * @since MU (3.0.0)
    609609     *
    610610     * @param string $blogname Site name.
     
    649649     * Filters site details and error messages following registration.
    650650     *
    651      * @since MU
     651     * @since MU (3.0.0)
    652652     *
    653653     * @param array $result {
     
    668668 * Record site signup information for future activation.
    669669 *
    670  * @since MU
     670 * @since MU (3.0.0)
    671671 *
    672672 * @global wpdb $wpdb WordPress database abstraction object.
     
    734734 * new site registration is not.
    735735 *
    736  * @since MU
     736 * @since MU (3.0.0)
    737737 *
    738738 * @global wpdb $wpdb WordPress database abstraction object.
     
    801801 * and subject line of the email sent to newly registered users.
    802802 *
    803  * @since MU
     803 * @since MU (3.0.0)
    804804 *
    805805 * @param string $domain     The new blog domain.
     
    816816     * Filters whether to bypass the new site email notification.
    817817     *
    818      * @since MU
     818     * @since MU (3.0.0)
    819819     *
    820820     * @param string|bool $domain     Site domain.
     
    852852         * Content should be formatted for transmission via wp_mail().
    853853         *
    854          * @since MU
     854         * @since MU (3.0.0)
    855855         *
    856856         * @param string $content    Content of the notification email.
     
    876876         * Filters the subject of the new blog notification email.
    877877         *
    878          * @since MU
     878         * @since MU (3.0.0)
    879879         *
    880880         * @param string $subject    Subject of the notification email.
     
    917917 * and subject line of the email sent to newly registered users.
    918918 *
    919  * @since MU
     919 * @since MU (3.0.0)
    920920 *
    921921 * @param string $user_login The user's login name.
     
    929929     * Filters whether to bypass the email notification for new user sign-up.
    930930     *
    931      * @since MU
     931     * @since MU (3.0.0)
    932932     *
    933933     * @param string $user_login User login name.
     
    954954         * Content should be formatted for transmission via wp_mail().
    955955         *
    956          * @since MU
     956         * @since MU (3.0.0)
    957957         *
    958958         * @param string $content    Content of the notification email.
     
    973973         * Filters the subject of the notification email of new user signup.
    974974         *
    975          * @since MU
     975         * @since MU (3.0.0)
    976976         *
    977977         * @param string $subject    Subject of the notification email.
     
    10061006 * by a Super Admin).
    10071007 *
    1008  * @since MU
     1008 * @since MU (3.0.0)
    10091009 *
    10101010 * @global wpdb $wpdb WordPress database abstraction object.
     
    10521052         * Fires immediately after a new user is activated.
    10531053         *
    1054          * @since MU
     1054         * @since MU (3.0.0)
    10551055         *
    10561056         * @param int   $user_id  User ID.
     
    10791079     * Fires immediately after a site is activated.
    10801080     *
    1081      * @since MU
     1081     * @since MU (3.0.0)
    10821082     *
    10831083     * @param int    $blog_id       Blog ID.
     
    11001100 * use {@see'user_register'}).
    11011101 *
    1102  * @since MU
     1102 * @since MU (3.0.0)
    11031103 *
    11041104 * @param string $user_name The new user's login name.
     
    11211121     * Fires immediately after a new user is created.
    11221122     *
    1123      * @since MU
     1123     * @since MU (3.0.0)
    11241124     *
    11251125     * @param int $user_id User ID.
     
    11421142 * root domain (eg 'blog1.example.com'), and $path is '/'.
    11431143 *
    1144  * @since MU
     1144 * @since MU (3.0.0)
    11451145 *
    11461146 * @param string $domain  The new site's domain.
     
    12071207     * Fires immediately after a new site is created.
    12081208     *
    1209      * @since MU
     1209     * @since MU (3.0.0)
    12101210     *
    12111211     * @param int    $blog_id Site ID.
     
    12291229 * the notification email.
    12301230 *
    1231  * @since MU
     1231 * @since MU (3.0.0)
    12321232 *
    12331233 * @param int    $blog_id    The new site's ID.
     
    12601260     * to the network administrator.
    12611261     *
    1262      * @since MU
     1262     * @since MU (3.0.0)
    12631263     *
    12641264     * @param string $msg Email body.
     
    12761276 * the notification email.
    12771277 *
    1278  * @since MU
     1278 * @since MU (3.0.0)
    12791279 *
    12801280 * @param int $user_id The new user's ID.
     
    13031303     * to the network administrator.
    13041304     *
    1305      * @since MU
     1305     * @since MU (3.0.0)
    13061306     *
    13071307     * @param string  $msg  Email body.
     
    13191319 * that each blogname is unique.
    13201320 *
    1321  * @since MU
     1321 * @since MU (3.0.0)
    13221322 *
    13231323 * @global wpdb $wpdb WordPress database abstraction object.
     
    13581358 * the new blog's ID. It is the first step in creating a new blog.
    13591359 *
    1360  * @since MU
     1360 * @since MU (3.0.0)
    13611361 *
    13621362 * @global wpdb $wpdb WordPress database abstraction object.
     
    13921392 * points to the new blog.
    13931393 *
    1394  * @since MU
     1394 * @since MU (3.0.0)
    13951395 *
    13961396 * @global wpdb     $wpdb
     
    14581458 * This function creates a row in the wp_blogs table.
    14591459 *
    1460  * @since MU
     1460 * @since MU (3.0.0)
    14611461 * @deprecated MU
    14621462 * @deprecated Use wp_install_defaults()
     
    14871487 * modify the content and subject line of the notification email.
    14881488 *
    1489  * @since MU
     1489 * @since MU (3.0.0)
    14901490 *
    14911491 * @param int    $blog_id  Blog ID.
     
    15041504     * Returning false disables the welcome email.
    15051505     *
    1506      * @since MU
     1506     * @since MU (3.0.0)
    15071507     *
    15081508     * @param int|bool $blog_id  Blog ID.
     
    15511551     * Content should be formatted for transmission via wp_mail().
    15521552     *
    1553      * @since MU
     1553     * @since MU (3.0.0)
    15541554     *
    15551555     * @param string $welcome_email Message body of the email.
     
    15791579     * Filters the subject of the welcome email after site activation.
    15801580     *
    1581      * @since MU
     1581     * @since MU (3.0.0)
    15821582     *
    15831583     * @param string $subject Subject of the email.
     
    16011601 * modify the content and subject line of the notification email.
    16021602 *
    1603  * @since MU
     1603 * @since MU (3.0.0)
    16041604 *
    16051605 * @param int    $user_id  User ID.
     
    16161616     * Returning false disables the welcome email.
    16171617     *
    1618      * @since MU
     1618     * @since MU (3.0.0)
    16191619     *
    16201620     * @param int    $user_id  User ID.
     
    16361636     * Content should be formatted for transmission via wp_mail().
    16371637     *
    1638      * @since MU
     1638     * @since MU (3.0.0)
    16391639     *
    16401640     * @param string $welcome_email The message body of the account activation success email.
     
    16671667     * Filters the subject of the welcome email after user activation.
    16681668     *
    1669      * @since MU
     1669     * @since MU (3.0.0)
    16701670     *
    16711671     * @param string $subject Subject of the email.
     
    16891689 * @see wpmu_current_site()
    16901690 *
    1691  * @since MU
     1691 * @since MU (3.0.0)
    16921692 *
    16931693 * @global WP_Network $current_site
     
    17061706 * the most recent post_date_gmt.
    17071707 *
    1708  * @since MU
     1708 * @since MU (3.0.0)
    17091709 *
    17101710 * @global wpdb $wpdb WordPress database abstraction object.
     
    17541754 * a blog has exceeded its allowed upload space.
    17551755 *
    1756  * @since MU
     1756 * @since MU (3.0.0)
    17571757 *
    17581758 * @param string $directory Full path of a directory.
     
    17851785 * other directories.
    17861786 *
    1787  * @since MU
     1787 * @since MU (3.0.0)
    17881788 * @since 4.3.0 $exclude parameter added.
    17891789 *
     
    18281828 * Super Admins at wp-admin/network/settings.php.
    18291829 *
    1830  * @since MU
     1830 * @since MU (3.0.0)
    18311831 *
    18321832 * @param array $mimes
     
    18531853 * or unpublished to make sure the count stays current.
    18541854 *
    1855  * @since MU
     1855 * @since MU (3.0.0)
    18561856 *
    18571857 * @global wpdb $wpdb WordPress database abstraction object.
     
    18671867 * Logs the user email, IP, and registration date of a new site.
    18681868 *
    1869  * @since MU
     1869 * @since MU (3.0.0)
    18701870 *
    18711871 * @global wpdb $wpdb WordPress database abstraction object.
     
    19591959 *
    19601960 * @see wp_validate_redirect()
    1961  * @since MU
     1961 * @since MU (3.0.0)
    19621962 *
    19631963 * @param array|string $deprecated Not used.
     
    19711971 * Check whether an upload is too big.
    19721972 *
    1973  * @since MU
     1973 * @since MU (3.0.0)
    19741974 *
    19751975 * @blessed
     
    19921992 * Add a nonce field to the signup page.
    19931993 *
    1994  * @since MU
     1994 * @since MU (3.0.0)
    19951995 */
    19961996function signup_nonce_fields() {
     
    20032003 * Process the signup nonce created in signup_nonce_fields().
    20042004 *
    2005  * @since MU
     2005 * @since MU (3.0.0)
    20062006 *
    20072007 * @param array $result
     
    20212021 * Correct 404 redirects when NOBLOGREDIRECT is defined.
    20222022 *
    2023  * @since MU
     2023 * @since MU (3.0.0)
    20242024 */
    20252025function maybe_redirect_404() {
     
    20482048 * added, as when a user is invited through the regular WP Add User interface.
    20492049 *
    2050  * @since MU
     2050 * @since MU (3.0.0)
    20512051 */
    20522052function maybe_add_existing_user_to_blog() {
     
    20732073 * Add a user to a blog based on details from maybe_add_existing_user_to_blog().
    20742074 *
    2075  * @since MU
     2075 * @since MU (3.0.0)
    20762076 *
    20772077 * @param array $details
     
    20852085         * Fires immediately after an existing user is added to a site.
    20862086         *
    2087          * @since MU
     2087         * @since MU (3.0.0)
    20882088         *
    20892089         * @param int   $user_id User ID.
     
    21012101 * is specifically hooked into the {@see 'wpmu_activate_user'} action.
    21022102 *
    2103  * @since MU
     2103 * @since MU (3.0.0)
    21042104 * @see add_user_to_blog()
    21052105 *
     
    21212121 * Correct From host on outgoing mail to match the site domain
    21222122 *
    2123  * @since MU
     2123 * @since MU (3.0.0)
    21242124 *
    21252125 * @param PHPMailer $phpmailer The PHPMailer instance, passed by reference.
     
    21322132 * Check to see whether a user is marked as a spammer, based on user login.
    21332133 *
    2134  * @since MU
     2134 * @since MU (3.0.0)
    21352135 *
    21362136 * @param string|WP_User $user Optional. Defaults to current user. WP_User object,
     
    21552155 * Public blogs have a setting of 1, private blogs are 0.
    21562156 *
    2157  * @since MU
     2157 * @since MU (3.0.0)
    21582158 *
    21592159 * @param int $old_value
     
    21672167 * Check whether a usermeta key has to do with the current blog.
    21682168 *
    2169  * @since MU
     2169 * @since MU (3.0.0)
    21702170 *
    21712171 * @global wpdb $wpdb WordPress database abstraction object.
     
    21912191 * Check whether users can self-register, based on Network settings.
    21922192 *
    2193  * @since MU
     2193 * @since MU (3.0.0)
    21942194 *
    21952195 * @return bool
     
    22032203 * Ensure that the welcome message is not empty. Currently unused.
    22042204 *
    2205  * @since MU
     2205 * @since MU (3.0.0)
    22062206 *
    22072207 * @param string $text
     
    24182418 * Returns the upload quota for the current blog.
    24192419 *
    2420  * @since MU
     2420 * @since MU (3.0.0)
    24212421 *
    24222422 * @return int Quota in megabytes
Note: See TracChangeset for help on using the changeset viewer.