Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues 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. 

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-activate.php
View File

@ -36,7 +36,7 @@ do_action( 'activate_header' );
*
* Fires on {@see 'wp_head'}.
*
* @since MU
* @since MU (3.0.0)
*/
function do_activate_header() {
/**
@ -53,7 +53,7 @@ add_action( 'wp_head', 'do_activate_header' );
/**
* Loads styles specific to this page.
*
* @since MU
* @since MU (3.0.0)
*/
function wpmu_activate_stylesheet() {
?>

4
wp-admin/includes/class-wp-ms-sites-list-table.php
View File

@ -236,7 +236,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
/**
* Filters the displayed site columns in Sites list table.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $sites_columns An array of displayed site columns. Default 'cb',
* 'blogname', 'lastupdated', 'registered', 'users'.
@ -420,7 +420,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
*
* By default this column is hidden unless something is hooked to the action.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id The site ID.
*/

2
wp-admin/includes/class-wp-ms-users-list-table.php
View File

@ -174,7 +174,7 @@ class WP_MS_Users_List_Table extends WP_List_Table {
/**
* Filters the columns displayed in the Network Admin Users list table.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $users_columns An array of user columns. Default 'cb', 'username',
* 'name', 'email', 'registered', 'blogs'.

6
wp-admin/includes/dashboard.php
View File

@ -419,7 +419,7 @@ function wp_network_dashboard_right_now() {
* Fires in the Network Admin 'Right Now' dashboard widget
* just before the user and site search form fields.
*
* @since MU
* @since MU (3.0.0)
*
* @param null $unused
*/
@ -445,14 +445,14 @@ function wp_network_dashboard_right_now() {
/**
* Fires at the end of the 'Right Now' widget in the Network Admin dashboard.
*
* @since MU
* @since MU (3.0.0)
*/
do_action( 'mu_rightnow_end' );
/**
* Fires at the end of the 'Right Now' widget in the Network Admin dashboard.
*
* @since MU
* @since MU (3.0.0)
*/
do_action( 'mu_activity_box_end' );
}

20
wp-admin/includes/ms.php
View File

@ -72,7 +72,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
/**
* Fires before a site is deleted.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id The site ID.
* @param bool $drop True if site's table should be dropped. Default is false.
@ -116,7 +116,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
/**
* Filters the tables to drop when the site is deleted.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $tables The site tables to be dropped.
* @param int $blog_id The ID of the site to drop tables for.
@ -132,7 +132,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
/**
* Filters the upload base directory to delete when the site is deleted.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $uploads['basedir'] Uploads path without subdirectory. @see wp_upload_dir()
* @param int $blog_id The site ID.
@ -221,7 +221,7 @@ function wpmu_delete_user( $id ) {
/**
* Fires before a user is deleted from the network.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id ID of the user about to be deleted from the network.
*/
@ -314,7 +314,7 @@ All at ###SITENAME###
* ###SITENAME### The name of the site.
* ###SITEURL### The URL to the site.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $email_text Text in the email.
* @param string $new_admin_email New admin email that the current administration email was changed to.
@ -338,7 +338,7 @@ All at ###SITENAME###
/**
* Check whether a site has used its allotted upload space.
*
* @since MU
* @since MU (3.0.0)
*
* @param bool $echo Optional. If $echo is set and the quota is exceeded, a warning message is echoed. Default is true.
* @return bool True if user is over upload space quota, otherwise false.
@ -365,7 +365,7 @@ function upload_is_user_over_quota( $echo = true ) {
/**
* Displays the amount of disk space used by the current site. Not used in core.
*
* @since MU
* @since MU (3.0.0)
*/
function display_space_usage() {
$space_allowed = get_space_allowed();
@ -393,7 +393,7 @@ function display_space_usage() {
/**
* Get the remaining upload space for this site.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $size Current max size in bytes
* @return int Max size in bytes
@ -530,7 +530,7 @@ function format_code_lang( $code = '' ) {
/**
* Filters the language codes.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $lang_codes Key/value pair of language codes where key is the short version.
* @param string $code A two-letter designation of the language.
@ -658,7 +658,7 @@ function mu_dropdown_languages( $lang_files = array(), $current = '' ) {
/**
* Filters the languages available in the dropdown.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $output HTML output of the dropdown.
* @param array $lang_files Available language files.

2
wp-admin/menu-header.php
View File

@ -31,7 +31,7 @@ global $menu, $submenu, $parent_file, $submenu_file;
*
* Allows plugins to move sub-menu items around.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $parent_file The parent file.
*/

4
wp-admin/my-sites.php
View File

@ -95,7 +95,7 @@ else :
* string to this filter will enable the section, and allow new settings
* to be added, either globally or for specific sites.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $settings_html The settings HTML markup. Default empty.
* @param object $context Context of the setting (global or site-specific). Default 'global'.
@ -113,7 +113,7 @@ else :
/**
* Filters the row links displayed for each site on the My Sites screen.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $string The HTML site link markup.
* @param object $user_blog An object containing the site data.

6
wp-admin/network/settings.php
View File

@ -80,7 +80,7 @@ if ( $_POST ) {
/**
* Fires after the network options are updated.
*
* @since MU
* @since MU (3.0.0)
*/
do_action( 'update_wpmu_options' );
@ -370,7 +370,7 @@ if ( isset( $_GET['updated'] ) ) {
* default option, 'plugins' is enabled, site administrators are granted access to the Plugins
* screen in their individual sites' dashboards.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $admin_menus The menu items available.
*/
@ -393,7 +393,7 @@ if ( isset( $_GET['updated'] ) ) {
/**
* Fires at the end of the Network Settings form, before the submit button.
*
* @since MU
* @since MU (3.0.0)
*/
do_action( 'wpmu_options' ); ?>
<?php submit_button(); ?>

4
wp-admin/network/sites.php
View File

@ -229,7 +229,7 @@ if ( isset( $_GET['action'] ) ) {
/**
* Fires after a network site is activated.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $id The ID of the activated site.
*/
@ -240,7 +240,7 @@ if ( isset( $_GET['action'] ) ) {
/**
* Fires before a network site is deactivated.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $id The ID of the site being deactivated.
*/

6
wp-admin/network/upgrade.php
View File

@ -94,7 +94,7 @@ switch ( $action ) {
/**
* Fires after the Multisite DB upgrade for each site is complete.
*
* @since MU
* @since MU (3.0.0)
*
* @param array|WP_Error $response The upgrade response array or WP_Error on failure.
*/
@ -102,7 +102,7 @@ switch ( $action ) {
/**
* Fires after each site has been upgraded.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $site_id The Site ID.
*/
@ -133,7 +133,7 @@ switch ( $action ) {
/**
* Fires before the footer on the network upgrade screen.
*
* @since MU
* @since MU (3.0.0)
*/
do_action( 'wpmu_upgrade_page' );
break;

2
wp-includes/class-wp-theme.php
View File

@ -1270,7 +1270,7 @@ final class WP_Theme implements ArrayAccess {
/**
* Filters the array of themes allowed on the network.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $allowed_themes An array of theme stylesheet names.
*/

2
wp-includes/deprecated.php
View File

@ -2798,7 +2798,7 @@ function wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) {
/**
* Checks if the current user belong to a given site.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.3.0 Use is_user_member_of_blog()
* @see is_user_member_of_blog()
*

54
wp-includes/ms-blogs.php
View File

@ -5,13 +5,13 @@
*
* @package WordPress
* @subpackage Multisite
* @since MU
* @since MU (3.0.0)
*/
/**
* Update the last_updated field for the current site.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*/
@ -22,7 +22,7 @@ function wpmu_update_blogs_date() {
/**
* Fires after the blog details are updated.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Site ID.
*/
@ -32,7 +32,7 @@ function wpmu_update_blogs_date() {
/**
* Get a full blog URL, given a blog id.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID
* @return string Full URL of the blog if found. Empty string if not.
@ -53,7 +53,7 @@ function get_blogaddress_by_id( $blog_id ) {
/**
* Get a full blog URL, given a blog name.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $blogname The (subdomain or directory) name
* @return string
@ -74,7 +74,7 @@ function get_blogaddress_by_name( $blogname ) {
/**
* Retrieves a sites ID given its (subdomain or directory) slug.
*
* @since MU
* @since MU (3.0.0)
* @since 4.7.0 Converted to use get_sites().
*
* @param string $slug A site's slug.
@ -109,7 +109,7 @@ function get_id_from_blogname( $slug ) {
/**
* Retrieve the details for a blog from the blogs table and blog options.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@ -239,7 +239,7 @@ function get_blog_details( $fields = null, $get_all = true ) {
/**
* Filters a blog's details.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 4.7.0 Use site_details
*
* @param object $details The blog details.
@ -257,7 +257,7 @@ function get_blog_details( $fields = null, $get_all = true ) {
/**
* Clear the blog details cache.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Optional. Blog ID. Defaults to current blog.
*/
@ -294,7 +294,7 @@ function refresh_blog_details( $blog_id = 0 ) {
/**
* Update the details for a blog. Updates the blogs table for a given blog id.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@ -341,7 +341,7 @@ function update_blog_details( $blog_id, $details = array() ) {
/**
* Fires when the 'spam' status is added to a blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
*/
@ -350,7 +350,7 @@ function update_blog_details( $blog_id, $details = array() ) {
/**
* Fires when the 'spam' status is removed from a blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
*/
@ -387,7 +387,7 @@ function update_blog_details( $blog_id, $details = array() ) {
/**
* Fires when the 'archived' status is added to a blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
*/
@ -396,7 +396,7 @@ function update_blog_details( $blog_id, $details = array() ) {
/**
* Fires when the 'archived' status is removed from a blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
*/
@ -648,7 +648,7 @@ function get_sites( $args = array() ) {
*
* If the option was serialized then it will be unserialized when it is returned.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
@ -693,7 +693,7 @@ function get_blog_option( $id, $option, $default = false ) {
* aren't adding a protected WordPress option. Care should be taken to not name
* options the same as the ones which are protected.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to add. Expected to not be SQL-escaped.
@ -719,7 +719,7 @@ function add_blog_option( $id, $option, $value ) {
/**
* Removes option by name for a given blog id. Prevents removal of protected WordPress options.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to remove. Expected to not be SQL-escaped.
@ -744,7 +744,7 @@ function delete_blog_option( $id, $option ) {
/**
* Update an option for a particular blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id The blog id.
* @param string $option The option key.
@ -779,7 +779,7 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
* - plugins. See #14941
*
* @see restore_current_blog()
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global int $blog_id
@ -811,7 +811,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
/**
* Fires when the blog is switched.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $new_blog New blog ID.
* @param int $new_blog Blog ID.
@ -865,7 +865,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
* Restore the current blog, after calling switch_to_blog()
*
* @see switch_to_blog()
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global array $_wp_switched_stack
@ -953,7 +953,7 @@ function ms_is_switched() {
/**
* Check if a particular blog is archived.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id The blog id
* @return string Whether the blog is archived or not
@ -965,7 +965,7 @@ function is_archived( $id ) {
/**
* Update the 'archived' status of a particular blog.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $id The blog id
* @param string $archived The new status
@ -979,7 +979,7 @@ function update_archived( $id, $archived ) {
/**
* Update a blog details field.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@ -1041,7 +1041,7 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
/**
* Fires after the current blog's 'public' setting is updated.
*
* @since MU
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
* @param string $value The value of blog status.
@ -1055,7 +1055,7 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
/**
* Get a blog details field.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@ -1076,7 +1076,7 @@ function get_blog_status( $id, $pref ) {
/**
* Get a list of most recently updated blogs.
*
* @since MU
* @since MU (3.0.0)
*
* @global wpdb $wpdb WordPress database abstraction object.
*

32
wp-includes/ms-deprecated.php
View File

@ -17,7 +17,7 @@
* Get the "dashboard blog", the blog where users without a blog edit their profile data.
* Dashboard blog functionality was removed in WordPress 3.1, replaced by the user admin.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.1.0 Use get_site()
* @see get_site()
*
@ -35,7 +35,7 @@ function get_dashboard_blog() {
/**
* Generates a random password.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use wp_generate_password()
* @see wp_generate_password()
*
@ -55,7 +55,7 @@ function generate_random_password( $len = 8 ) {
* This function must reside in a file included only if is_multisite() due to
* legacy function_exists() checks to determine if multisite is enabled.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use is_super_admin()
* @see is_super_admin()
*
@ -82,7 +82,7 @@ if ( !function_exists( 'graceful_fail' ) ) :
/**
* Deprecated functionality to gracefully fail.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use wp_die()
* @see wp_die()
*/
@ -120,7 +120,7 @@ endif;
/**
* Deprecated functionality to retrieve user information.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use get_user_by()
* @see get_user_by()
*
@ -134,7 +134,7 @@ function get_user_details( $username ) {
/**
* Deprecated functionality to clear the global post cache.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use clean_post_cache()
* @see clean_post_cache()
*
@ -147,7 +147,7 @@ function clear_global_post_cache( $post_id ) {
/**
* Deprecated functionality to determin if the current site is the main site.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use is_main_site()
* @see is_main_site()
*/
@ -159,7 +159,7 @@ function is_main_blog() {
/**
* Deprecated functionality to validate an email address.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use is_email()
* @see is_email()
*
@ -175,7 +175,7 @@ function validate_email( $email, $check_domain = true) {
/**
* Deprecated functionality to retrieve a list of all sites.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use wp_get_sites()
* @see wp_get_sites()
*
@ -209,7 +209,7 @@ function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
/**
* Deprecated functionality to retrieve a list of the most active sites.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0
*
* @param int $num Optional. Number of activate blogs to retrieve. Default 10.
@ -261,7 +261,7 @@ function get_most_active_blogs( $num = 10, $display = true ) {
* 5) $_POST['redirect']
* 6) $url
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.3.0 Use wp_redirect()
* @see wp_redirect()
*
@ -300,7 +300,7 @@ function wpmu_admin_do_redirect( $url = '' ) {
/**
* Adds an 'updated=true' argument to a URL.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.3.0 Use add_query_arg()
* @see add_query_arg()
*
@ -325,7 +325,7 @@ function wpmu_admin_redirect_add_updated_param( $url = '' ) {
* A numeric string is considered to be an existing user ID
* and is simply returned as such.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.6.0 Use get_user_by()
* @see get_user_by()
*
@ -350,7 +350,7 @@ function get_user_id_from_string( $string ) {
/**
* Get a full blog URL, given a domain and a path.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.7.0
*
* @param string $domain
@ -379,7 +379,7 @@ function get_blogaddress_by_domain( $domain, $path ) {
/**
* Create an empty blog.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
* @deprecated 4.4.0
*
* @param string $domain The new blog's domain.
@ -415,7 +415,7 @@ function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) {
/**
* Get the admin for a domain/path combination.
*
* @since MU 1.0
* @since MU (3.0.0) 1.0
* @deprecated 4.4.0
*
* @global wpdb $wpdb WordPress database abstraction object.

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
*/

8
wp-includes/user.php
View File

@ -423,7 +423,7 @@ function count_many_users_posts( $users, $post_type = 'post', $public_only = fal
/**
* Get the current user's ID
*
* @since MU
* @since MU (3.0.0)
*
* @return int The current user's ID, or 0 if no user is logged in.
*/
@ -679,7 +679,7 @@ function get_blogs_of_user( $user_id, $all = false ) {
/**
* Filters the list of sites a user belongs to.
*
* @since MU
* @since MU (3.0.0)
*
* @param array $sites An array of site objects belonging to the user.
* @param int $user_id User ID.
@ -692,7 +692,7 @@ function get_blogs_of_user( $user_id, $all = false ) {
/**
* Find out whether a user is a member of a given blog.
*
* @since MU 1.1
* @since MU (3.0.0) 1.1
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@ -2669,7 +2669,7 @@ All at ###SITENAME###
* ###SITENAME### The name of the site.
* ###SITEURL### The URL to the site.
*
* @since MU
* @since MU (3.0.0)
* @since 4.9.0 This filter is no longer Multisite specific.
*
* @param string $email_text Text in the email.

2
wp-includes/version.php
View File

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

34
wp-signup.php
View File

@ -15,7 +15,7 @@ if ( is_array( get_site_option( 'illegal_names' )) && isset( $_GET[ 'new' ] ) &&
/**
* Prints signup_header via wp_head
*
* @since MU
* @since MU (3.0.0)
*/
function do_signup_header() {
/**
@ -50,7 +50,7 @@ do_action( 'before_signup_header' );
/**
* Prints styles for front-end Multisite signup pages
*
* @since MU
* @since MU (3.0.0)
*/
function wpmu_signup_stylesheet() {
?>
@ -89,7 +89,7 @@ do_action( 'before_signup_form' );
/**
* Generates and displays the Signup and Create Site forms
*
* @since MU
* @since MU (3.0.0)
*
* @param string $blogname The new site name.
* @param string $blog_title The new site title.
@ -198,7 +198,7 @@ function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
/**
* Validate the new site signup
*
* @since MU
* @since MU (3.0.0)
*
* @return array Contains the new site data and error messages.
*/
@ -213,7 +213,7 @@ function validate_blog_form() {
/**
* Display user registration form
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_name The entered username.
* @param string $user_email The entered email address.
@ -255,7 +255,7 @@ function show_user_form($user_name = '', $user_email = '', $errors = '') {
/**
* Validate user signup name and email
*
* @since MU
* @since MU (3.0.0)
*
* @return array Contains username, email, and error messages.
*/
@ -266,7 +266,7 @@ function validate_user_form() {
/**
* Allow returning users to sign up for another site
*
* @since MU
* @since MU (3.0.0)
*
* @param string $blogname The new site name
* @param string $blog_title The new site title.
@ -332,7 +332,7 @@ function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
/**
* Hidden sign-up form fields output when creating another site or user.
*
* @since MU
* @since MU (3.0.0)
*
* @param string $context A string describing the steps of the sign-up process. The value can be
* 'create-another-site', 'validate-user', or 'validate-site'.
@ -348,7 +348,7 @@ function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
/**
* Validate a new site signup.
*
* @since MU
* @since MU (3.0.0)
*
* @return null|bool True if site signup was validated, false if error.
* The function halts all execution if the user is not logged in.
@ -401,7 +401,7 @@ function validate_another_blog_signup() {
*
* Use the {@see 'add_signup_meta'} filter instead.
*
* @since MU
* @since MU (3.0.0)
* @deprecated 3.0.0 Use the {@see 'add_signup_meta'} filter instead.
*
* @param array $blog_meta_defaults An array of default blog meta variables.
@ -435,7 +435,7 @@ function validate_another_blog_signup() {
/**
* Confirm a new site signup.
*
* @since MU
* @since MU (3.0.0)
* @since 4.4.0 Added the `$blog_id` parameter.
*
* @param string $domain The domain URL.
@ -490,7 +490,7 @@ function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $
/**
* Setup the new user signup process
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_name The username.
* @param string $user_email The user's email.
@ -564,7 +564,7 @@ function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
/**
* Validate the new user signup
*
* @since MU
* @since MU (3.0.0)
*
* @return bool True if new user signup was validated, false if error
*/
@ -594,7 +594,7 @@ function validate_user_signup() {
/**
* New user signup confirmation
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_name The username
* @param string $user_email The user's email address
@ -615,7 +615,7 @@ function confirm_user_signup($user_name, $user_email) {
/**
* Setup the new site signup
*
* @since MU
* @since MU (3.0.0)
*
* @param string $user_name The username.
* @param string $user_email The user's email address.
@ -678,7 +678,7 @@ function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_ti
/**
* Validate new site signup
*
* @since MU
* @since MU (3.0.0)
*
* @return bool True if the site signup was validated, false if error
*/
@ -735,7 +735,7 @@ function validate_blog_signup() {
/**
* New site signup confirmation
*
* @since MU
* @since MU (3.0.0)
*
* @param string $domain The domain URL
* @param string $path The site root path