IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.

Browse Source 
Props sathyapulse.
Fixes #41509.

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


git-svn-id: http://core.svn.wordpress.org/trunk@41040 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2017-08-01 20:44:43 +00:00
parent ed60c36fb8
commit 0401cee8b3
18 changed files with 169 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
wp-includes/ms-functions.php
View File

@@ -10,7 +10,7 @@
/**
* Gets the network's site and user counts.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @return array Site and user count for the network.
*/
@@ -32,7 +32,7 @@ function get_sitestats() {
* is added as a Subscriber to the Dashboard Blog and that blog
* is returned.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -95,7 +95,7 @@ function get_active_blog_for_user( $user_id ) {
*
* The count is cached and updated twice daily. This is not a live count.
*
* @since MU 2.7
* @since MU (3.0.0) 2.7
* @since 4.8.0 The $network_id parameter has been added.
*
* @param int|null $network_id ID of the network. Default is the current network.
@@ -110,7 +110,7 @@ function get_user_count( $network_id = null ) {
*
* The count is cached and updated twice daily. This is not a live count.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
* @since 3.7.0 The $network_id parameter has been deprecated.
* @since 4.8.0 The $network_id parameter is now being used.
*
@@ -124,7 +124,7 @@ function get_blog_count( $network_id = null ) {
/**
* Get a blog post from any site on the network.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @param int $blog_id ID of the blog.
* @param int $post_id ID of the post you're looking for.
@@ -143,7 +143,7 @@ function get_blog_post( $blog_id, $post_id ) {
*
* Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @param int $blog_id ID of the blog you're adding the user to.
* @param int $user_id ID of the user you're adding.
@@ -171,7 +171,7 @@ function add_user_to_blog( $blog_id, $user_id, $role ) {
/**
* Fires immediately after a user is added to a site.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param string $role User role.
@@ -193,7 +193,7 @@ function add_user_to_blog( $blog_id, $user_id, $role ) {
* Accepts an optional `$reassign` parameter, if you want to
* reassign the user's blog posts to another user upon removal.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -209,7 +209,7 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') {
/**
* Fires before a user is removed from a site.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param int $blog_id Blog ID.
@@ -274,7 +274,7 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') {
/**
* Get the permalink for a post on another blog.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
*
* @param int $blog_id ID of the source blog.
* @param int $post_id ID of the desired post.
@@ -296,7 +296,7 @@ function get_blog_permalink( $blog_id, $post_id ) {
* subdirectory '/blog1/'. With subdomains like blog1.example.com,
* $domain is 'blog1.example.com' and $path is '/'.
*
* @since MU 2.6.5
* @since MU (3.0.0) 2.6.5
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -342,7 +342,7 @@ function get_blog_id_from_url( $domain, $path = '/' ) {
* self-registrations; user creation at wp-admin/network/users.php
* bypasses this check.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_email The email provided by the user at registration.
* @return bool Returns true when the email address is banned.
@@ -400,7 +400,7 @@ function is_email_address_unsafe( $user_email ) {
* allows you to process the data in any way you'd like, and unset the relevant errors if
* necessary.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -506,7 +506,7 @@ function wpmu_validate_user_signup($user_name, $user_email) {
* This does not allow you to override the username or email of the user during
* registration. The values are solely used for validation and error handling.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $result {
* The array of user name, email and the error messages.
@@ -534,7 +534,7 @@ function wpmu_validate_user_signup($user_name, $user_email) {
* Filter {@see 'wpmu_validate_blog_signup'} if you want to modify
* the way that WordPress validates new site signups.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global string $domain
@@ -605,7 +605,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
* The name is the site's subdomain or the site's subdirectory
* path depending on the network settings.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $blogname Site name.
*/
@@ -648,7 +648,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
/**
* Filters site details and error messages following registration.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $result {
* Array of domain, path, blog name, blog title, user and error messages.
@@ -667,7 +667,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
/**
* Record site signup information for future activation.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -733,7 +733,7 @@ function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = a
* This function is used when user registration is open but
* new site registration is not.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -800,7 +800,7 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) {
* {@see 'wpmu_signup_blog_notification_subject'} to change the content
* and subject line of the email sent to newly registered users.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $domain The new blog domain.
* @param string $path The new blog path.
@@ -815,7 +815,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $us
/**
* Filters whether to bypass the new site email notification.
*
* @since MU
* @since MU (3.0.0)
*
* @param string|bool $domain Site domain.
* @param string $path Site path.
@@ -851,7 +851,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $us
*
* Content should be formatted for transmission via wp_mail().
*
* @since MU
* @since MU (3.0.0)
*
* @param string $content Content of the notification email.
* @param string $domain Site domain.
@@ -875,7 +875,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $us
/**
* Filters the subject of the new blog notification email.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $subject Subject of the notification email.
* @param string $domain Site domain.
@@ -916,7 +916,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $us
* {@see 'wpmu_signup_user_notification_subject'} to change the content
* and subject line of the email sent to newly registered users.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_login The user's login name.
* @param string $user_email The user's email address.
@@ -928,7 +928,7 @@ function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta =
/**
* Filters whether to bypass the email notification for new user sign-up.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_login User login name.
* @param string $user_email User email address.
@@ -953,7 +953,7 @@ function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta =
*
* Content should be formatted for transmission via wp_mail().
*
* @since MU
* @since MU (3.0.0)
*
* @param string $content Content of the notification email.
* @param string $user_login User login name.
@@ -972,7 +972,7 @@ function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta =
/**
* Filters the subject of the notification email of new user signup.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $subject Subject of the notification email.
* @param string $user_login User login name.
@@ -1005,7 +1005,7 @@ function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta =
* those actions are not called when users and sites are created
* by a Super Admin).
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1051,7 +1051,7 @@ function wpmu_activate_signup($key) {
/**
* Fires immediately after a new user is activated.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param int $password User password.
@@ -1078,7 +1078,7 @@ function wpmu_activate_signup($key) {
/**
* Fires immediately after a site is activated.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
* @param int $user_id User ID.
@@ -1099,7 +1099,7 @@ function wpmu_activate_signup($key) {
* that should affect all new users, but only on Multisite (otherwise
* use {@see'user_register'}).
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_name The new user's login name.
* @param string $password The new user's password.
@@ -1120,7 +1120,7 @@ function wpmu_create_user( $user_name, $password, $email ) {
/**
* Fires immediately after a new user is created.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
*/
@@ -1141,7 +1141,7 @@ function wpmu_create_user( $user_name, $password, $email ) {
* and '/blog1/'). On subdomain installs, $domain is the new subdomain +
* root domain (eg 'blog1.example.com'), and $path is '/'.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $domain The new site's domain.
* @param string $path The new site's path.
@@ -1206,7 +1206,7 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $s
/**
* Fires immediately after a new site is created.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Site ID.
* @param int $user_id User ID.
@@ -1228,7 +1228,7 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $s
* Filter {@see 'newblog_notify_siteadmin'} to change the content of
* the notification email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id The new site's ID.
* @param string $deprecated Not used.
@@ -1259,7 +1259,7 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[
* Filters the message body of the new site activation email sent
* to the network administrator.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $msg Email body.
*/
@@ -1275,7 +1275,7 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[
* Filter {@see 'newuser_notify_siteadmin'} to change the content of
* the notification email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id The new user's ID.
* @return bool
@@ -1302,7 +1302,7 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE
* Filters the message body of the new user activation email sent
* to the network administrator.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $msg Email body.
* @param WP_User $user WP_User instance of the new user.
@@ -1318,7 +1318,7 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE
* Used during the new site registration process to ensure
* that each blogname is unique.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1357,7 +1357,7 @@ function domain_exists($domain, $path, $site_id = 1) {
* This function creates a row in the wp_blogs table and returns
* the new blog's ID. It is the first step in creating a new blog.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1391,7 +1391,7 @@ function insert_blog($domain, $path, $site_id) {
* directly, be sure to use switch_to_blog() first, so that $wpdb
* points to the new blog.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global WP_Roles $wp_roles
@@ -1457,7 +1457,7 @@ function install_blog( $blog_id, $blog_title = '' ) {
*
* This function creates a row in the wp_blogs table.
*
* @since MU
* @since MU (3.0.0)
* @deprecated MU
* @deprecated Use wp_install_defaults()
*
@@ -1486,7 +1486,7 @@ function install_blog_defaults($blog_id, $user_id) {
* Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to
* modify the content and subject line of the notification email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
* @param int $user_id User ID.
@@ -1503,7 +1503,7 @@ function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta
*
* Returning false disables the welcome email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int|bool $blog_id Blog ID.
* @param int $user_id User ID.
@@ -1550,7 +1550,7 @@ We hope you enjoy your new site. Thanks!
*
* Content should be formatted for transmission via wp_mail().
*
* @since MU
* @since MU (3.0.0)
*
* @param string $welcome_email Message body of the email.
* @param int $blog_id Blog ID.
@@ -1578,7 +1578,7 @@ We hope you enjoy your new site. Thanks!
/**
* Filters the subject of the welcome email after site activation.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $subject Subject of the email.
*/
@@ -1600,7 +1600,7 @@ We hope you enjoy your new site. Thanks!
* Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
* modify the content and subject line of the notification email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param string $password User password.
@@ -1615,7 +1615,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
*
* Returning false disables the welcome email.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param string $password User password.
@@ -1635,7 +1635,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
*
* Content should be formatted for transmission via wp_mail().
*
* @since MU
* @since MU (3.0.0)
*
* @param string $welcome_email The message body of the account activation success email.
* @param int $user_id User ID.
@@ -1666,7 +1666,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
/**
* Filters the subject of the welcome email after user activation.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $subject Subject of the email.
*/
@@ -1688,7 +1688,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
*
* @see wpmu_current_site()
*
* @since MU
* @since MU (3.0.0)
*
* @global WP_Network $current_site
*
@@ -1705,7 +1705,7 @@ function get_current_site() {
* Walks through each of a user's blogs to find the post with
* the most recent post_date_gmt.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1753,7 +1753,7 @@ function get_most_recent_post_of_user( $user_id ) {
* A helper function that is used primarily to check whether
* a blog has exceeded its allowed upload space.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $directory Full path of a directory.
* @return int Size of the directory in MB.
@@ -1784,7 +1784,7 @@ function get_dirsize( $directory ) {
* Used by get_dirsize() to get a directory's size when it contains
* other directories.
*
* @since MU
* @since MU (3.0.0)
* @since 4.3.0 $exclude parameter added.
*
* @param string $directory Full path of a directory.
@@ -1827,7 +1827,7 @@ function recurse_dirsize( $directory, $exclude = null ) {
* that list against the filetype whitelist provided by Multisite
* Super Admins at wp-admin/network/settings.php.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $mimes
* @return array
@@ -1852,7 +1852,7 @@ function check_upload_mimes( $mimes ) {
* with get_site(). This function is called when posts are published
* or unpublished to make sure the count stays current.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1866,7 +1866,7 @@ function update_posts_count( $deprecated = '' ) {
/**
* Logs the user email, IP, and registration date of a new site.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1958,7 +1958,7 @@ function global_terms( $term_id, $deprecated = '' ) {
* Ensure that the current site's domain is listed in the allowed redirect host list.
*
* @see wp_validate_redirect()
* @since MU
* @since MU (3.0.0)
*
* @param array|string $deprecated Not used.
* @return array The current site's domain
@@ -1970,7 +1970,7 @@ function redirect_this_site( $deprecated = '' ) {
/**
* Check whether an upload is too big.
*
* @since MU
* @since MU (3.0.0)
*
* @blessed
*
@@ -1991,7 +1991,7 @@ function upload_is_file_too_big( $upload ) {
/**
* Add a nonce field to the signup page.
*
* @since MU
* @since MU (3.0.0)
*/
function signup_nonce_fields() {
$id = mt_rand();
@@ -2002,7 +2002,7 @@ function signup_nonce_fields() {
/**
* Process the signup nonce created in signup_nonce_fields().
*
* @since MU
* @since MU (3.0.0)
*
* @param array $result
* @return array
@@ -2020,7 +2020,7 @@ function signup_nonce_check( $result ) {
/**
* Correct 404 redirects when NOBLOGREDIRECT is defined.
*
* @since MU
* @since MU (3.0.0)
*/
function maybe_redirect_404() {
/**
@@ -2047,7 +2047,7 @@ function maybe_redirect_404() {
* keyed as 'new_user_x', where 'x' is the username of the user to be
* added, as when a user is invited through the regular WP Add User interface.
*
* @since MU
* @since MU (3.0.0)
*/
function maybe_add_existing_user_to_blog() {
if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) )
@@ -2072,7 +2072,7 @@ function maybe_add_existing_user_to_blog() {
/**
* Add a user to a blog based on details from maybe_add_existing_user_to_blog().
*
* @since MU
* @since MU (3.0.0)
*
* @param array $details
* @return true|WP_Error|void
@@ -2084,7 +2084,7 @@ function add_existing_user_to_blog( $details = false ) {
/**
* Fires immediately after an existing user is added to a site.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param mixed $result True on success or a WP_Error object if the user doesn't exist.
@@ -2100,7 +2100,7 @@ function add_existing_user_to_blog( $details = false ) {
* To add a user in general, use add_user_to_blog(). This function
* is specifically hooked into the {@see 'wpmu_activate_user'} action.
*
* @since MU
* @since MU (3.0.0)
* @see add_user_to_blog()
*
* @param int $user_id
@@ -2120,7 +2120,7 @@ function add_new_user_to_blog( $user_id, $password, $meta ) {
/**
* Correct From host on outgoing mail to match the site domain
*
* @since MU
* @since MU (3.0.0)
*
* @param PHPMailer $phpmailer The PHPMailer instance, passed by reference.
*/
@@ -2131,7 +2131,7 @@ function fix_phpmailer_messageid( $phpmailer ) {
/**
* Check to see whether a user is marked as a spammer, based on user login.
*
* @since MU
* @since MU (3.0.0)
*
* @param string|WP_User $user Optional. Defaults to current user. WP_User object,
* or user login name as a string.
@@ -2154,7 +2154,7 @@ function is_user_spammy( $user = null ) {
*
* Public blogs have a setting of 1, private blogs are 0.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $old_value
* @param int $value The new public value
@@ -2166,7 +2166,7 @@ function update_blog_public( $old_value, $value ) {
/**
* Check whether a usermeta key has to do with the current blog.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -2190,7 +2190,7 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
/**
* Check whether users can self-register, based on Network settings.
*
* @since MU
* @since MU (3.0.0)
*
* @return bool
*/
@@ -2202,7 +2202,7 @@ function users_can_register_signup_filter() {
/**
* Ensure that the welcome message is not empty. Currently unused.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $text
* @return string
@@ -2417,7 +2417,7 @@ function get_space_used() {
/**
* Returns the upload quota for the current blog.
*
* @since MU
* @since MU (3.0.0)
*
* @return int Quota in megabytes
*/