WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Multisite: Update `@since` tags for site management APIs. 

Fixes #40364. Fixes #41333.

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


git-svn-id: http://core.svn.wordpress.org/trunk@44300 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Felix Arntz 2019-01-08 08:58:49 +00:00
parent 321bdfbacf
commit 0b15142c0b
5 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -56,7 +56,7 @@ function check_upload_size( $file ) {
* Delete a site. * Delete a site.
* *
* @since 3.0.0 * @since 3.0.0
* @since 5.0.0 Use wp_delete_site() internally to delete the site row from the database. * @since 5.1.0 Use wp_delete_site() internally to delete the site row from the database.
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -97,7 +97,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
wp_delete_site( $blog_id ); wp_delete_site( $blog_id );
} else { } else {
/** This action is documented in wp-includes/ms-blogs.php */ /** This action is documented in wp-includes/ms-blogs.php */
do_action_deprecated( 'delete_blog', array( $blog_id, false ), '5.0.0' ); do_action_deprecated( 'delete_blog', array( $blog_id, false ), '5.1.0' );
$users = get_users( $users = get_users(
array( array(
@ -116,7 +116,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
update_blog_status( $blog_id, 'deleted', 1 ); update_blog_status( $blog_id, 'deleted', 1 );
/** This action is documented in wp-includes/ms-blogs.php */ /** This action is documented in wp-includes/ms-blogs.php */
do_action_deprecated( 'deleted_blog', array( $blog_id, false ), '5.0.0' ); do_action_deprecated( 'deleted_blog', array( $blog_id, false ), '5.1.0' );
} }
if ( $switch ) { if ( $switch ) {

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

@ -400,7 +400,7 @@ function clean_site_details_cache( $site_id = 0 ) {
/** /**
* Inserts a new site into the database. * Inserts a new site into the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -464,7 +464,7 @@ function wp_insert_site( array $data ) {
/** /**
* Fires once a site has been inserted into the database. * Fires once a site has been inserted into the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site New site object. * @param WP_Site $new_site New site object.
*/ */
@ -473,7 +473,7 @@ function wp_insert_site( array $data ) {
/** /**
* Fires when a site's initialization routine should be executed. * Fires when a site's initialization routine should be executed.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site New site object. * @param WP_Site $new_site New site object.
* @param array $args Arguments for the initialization. * @param array $args Arguments for the initialization.
@ -489,7 +489,7 @@ function wp_insert_site( array $data ) {
* Fires immediately after a new site is created. * Fires immediately after a new site is created.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @deprecated 5.0.0 Use wp_insert_site * @deprecated 5.1.0 Use wp_insert_site
* *
* @param int $site_id Site ID. * @param int $site_id Site ID.
* @param int $user_id User ID. * @param int $user_id User ID.
@ -498,7 +498,7 @@ function wp_insert_site( array $data ) {
* @param int $network_id Network ID. Only relevant on multi-network installations. * @param int $network_id Network ID. Only relevant on multi-network installations.
* @param array $meta Meta data. Used to set initial site options. * @param array $meta Meta data. Used to set initial site options.
*/ */
do_action_deprecated( 'wpmu_new_blog', array( $new_site->id, $user_id, $new_site->domain, $new_site->path, $new_site->network_id, $meta ), '5.0.0', 'wp_insert_site' ); do_action_deprecated( 'wpmu_new_blog', array( $new_site->id, $user_id, $new_site->domain, $new_site->path, $new_site->network_id, $meta ), '5.1.0', 'wp_insert_site' );
} }
return (int) $new_site->id; return (int) $new_site->id;
@ -507,7 +507,7 @@ function wp_insert_site( array $data ) {
/** /**
* Updates a site in the database. * Updates a site in the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -548,7 +548,7 @@ function wp_update_site( $site_id, array $data ) {
/** /**
* Fires once a site has been updated in the database. * Fires once a site has been updated in the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site New site object. * @param WP_Site $new_site New site object.
* @param WP_Site $old_site Old site object. * @param WP_Site $old_site Old site object.
@ -561,7 +561,7 @@ function wp_update_site( $site_id, array $data ) {
/** /**
* Deletes a site from the database. * Deletes a site from the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -588,7 +588,7 @@ function wp_delete_site( $site_id ) {
* Plugins should amend the `$errors` object via its `WP_Error::add()` method. If any errors * Plugins should amend the `$errors` object via its `WP_Error::add()` method. If any errors
* are present, the site will not be deleted. * are present, the site will not be deleted.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Error $errors Error object to add validation errors to. * @param WP_Error $errors Error object to add validation errors to.
* @param WP_Site $old_site The site object to be deleted. * @param WP_Site $old_site The site object to be deleted.
@ -603,17 +603,17 @@ function wp_delete_site( $site_id ) {
* Fires before a site is deleted. * Fires before a site is deleted.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @deprecated 5.0.0 * @deprecated 5.1.0
* *
* @param int $site_id The site ID. * @param int $site_id The site ID.
* @param bool $drop True if site's table should be dropped. Default is false. * @param bool $drop True if site's table should be dropped. Default is false.
*/ */
do_action_deprecated( 'delete_blog', array( $old_site->id, true ), '5.0.0' ); do_action_deprecated( 'delete_blog', array( $old_site->id, true ), '5.1.0' );
/** /**
* Fires when a site's uninitialization routine should be executed. * Fires when a site's uninitialization routine should be executed.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $old_site Deleted site object. * @param WP_Site $old_site Deleted site object.
*/ */
@ -635,7 +635,7 @@ function wp_delete_site( $site_id ) {
/** /**
* Fires once a site has been deleted from the database. * Fires once a site has been deleted from the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $old_site Deleted site object. * @param WP_Site $old_site Deleted site object.
*/ */
@ -645,12 +645,12 @@ function wp_delete_site( $site_id ) {
* Fires after the site is deleted from the network. * Fires after the site is deleted from the network.
* *
* @since 4.8.0 * @since 4.8.0
* @deprecated 5.0.0 * @deprecated 5.1.0
* *
* @param int $site_id The site ID. * @param int $site_id The site ID.
* @param bool $drop True if site's tables should be dropped. Default is false. * @param bool $drop True if site's tables should be dropped. Default is false.
*/ */
do_action_deprecated( 'deleted_blog', array( $old_site->id, true ), '5.0.0' ); do_action_deprecated( 'deleted_blog', array( $old_site->id, true ), '5.1.0' );
return $old_site; return $old_site;
} }
@ -824,7 +824,7 @@ function get_sites( $args = array() ) {
/** /**
* Prepares site data for insertion or update in the database. * Prepares site data for insertion or update in the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param array $data Associative array of site data passed to the respective function. * @param array $data Associative array of site data passed to the respective function.
* See {@see wp_insert_site()} for the possibly included data. * See {@see wp_insert_site()} for the possibly included data.
@ -847,7 +847,7 @@ function wp_prepare_site_data( $data, $defaults, $old_site = null ) {
/** /**
* Filters passed site data in order to normalize it. * Filters passed site data in order to normalize it.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param array $data Associative array of site data passed to the respective function. * @param array $data Associative array of site data passed to the respective function.
* See {@see wp_insert_site()} for the possibly included data. * See {@see wp_insert_site()} for the possibly included data.
@ -864,7 +864,7 @@ function wp_prepare_site_data( $data, $defaults, $old_site = null ) {
* *
* Plugins should amend the `$errors` object via its `WP_Error::add()` method. * Plugins should amend the `$errors` object via its `WP_Error::add()` method.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Error $errors Error object to add validation errors to. * @param WP_Error $errors Error object to add validation errors to.
* @param array $data Associative array of complete site data. See {@see wp_insert_site()} * @param array $data Associative array of complete site data. See {@see wp_insert_site()}
@ -888,7 +888,7 @@ function wp_prepare_site_data( $data, $defaults, $old_site = null ) {
/** /**
* Normalizes data for a site prior to inserting or updating in the database. * Normalizes data for a site prior to inserting or updating in the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param array $data Associative array of site data passed to the respective function. * @param array $data Associative array of site data passed to the respective function.
* See {@see wp_insert_site()} for the possibly included data. * See {@see wp_insert_site()} for the possibly included data.
@ -940,7 +940,7 @@ function wp_normalize_site_data( $data ) {
/** /**
* Validates data for a site prior to inserting or updating in the database. * Validates data for a site prior to inserting or updating in the database.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Error $errors Error object, passed by reference. Will contain validation errors if * @param WP_Error $errors Error object, passed by reference. Will contain validation errors if
* any occurred. * any occurred.
@ -1008,7 +1008,7 @@ function wp_validate_site_data( $errors, $data, $old_site = null ) {
* This process includes creating the site's database tables and * This process includes creating the site's database tables and
* populating them with defaults. * populating them with defaults.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Roles $wp_roles WordPress role management object. * @global WP_Roles $wp_roles WordPress role management object.
@ -1062,7 +1062,7 @@ function wp_initialize_site( $site_id, array $args = array() ) {
/** /**
* Filters the arguments for initializing a site. * Filters the arguments for initializing a site.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param array $args Arguments to modify the initialization behavior. * @param array $args Arguments to modify the initialization behavior.
* @param WP_Site $site Site that is being initialized. * @param WP_Site $site Site that is being initialized.
@ -1148,7 +1148,7 @@ function wp_initialize_site( $site_id, array $args = array() ) {
* *
* This process includes dropping the site's database tables and deleting its uploads directory. * This process includes dropping the site's database tables and deleting its uploads directory.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -1270,7 +1270,7 @@ function wp_uninitialize_site( $site_id ) {
* *
* A site is considered initialized when its database tables are present. * A site is considered initialized when its database tables are present.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -1291,7 +1291,7 @@ function wp_is_site_initialized( $site_id ) {
* Returning a non-null value will effectively short-circuit the function, returning * Returning a non-null value will effectively short-circuit the function, returning
* that value instead. * that value instead.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param bool|null $pre The value to return, if not null. * @param bool|null $pre The value to return, if not null.
* @param int $site_id The site ID that is being checked. * @param int $site_id The site ID that is being checked.
@ -1763,7 +1763,7 @@ function update_archived( $id, $archived ) {
* Update a blog details field. * Update a blog details field.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @since 5.0.0 Use wp_update_site() internally. * @since 5.1.0 Use wp_update_site() internally.
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
@ -2066,7 +2066,7 @@ function _update_posts_count_on_transition_post_status( $new_status, $old_status
/** /**
* Updates the count of sites for a network based on a changed site. * Updates the count of sites for a network based on a changed site.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site The site object that has been inserted, updated or deleted. * @param WP_Site $new_site The site object that has been inserted, updated or deleted.
* @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous * @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous
@ -2087,7 +2087,7 @@ function wp_maybe_update_network_site_counts_on_update( $new_site, $old_site = n
/** /**
* Triggers actions on site status updates. * Triggers actions on site status updates.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site The site object after the update. * @param WP_Site $new_site The site object after the update.
* @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous * @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous
@ -2214,7 +2214,7 @@ function wp_maybe_transition_site_statuses_on_update( $new_site, $old_site = nul
/** /**
* Cleans the necessary caches after specific site data has been updated. * Cleans the necessary caches after specific site data has been updated.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param WP_Site $new_site The site object after the update. * @param WP_Site $new_site The site object after the update.
* @param WP_Site $old_site The site obejct prior to the update. * @param WP_Site $old_site The site obejct prior to the update.
@ -2228,7 +2228,7 @@ function wp_maybe_clean_new_site_cache_on_update( $new_site, $old_site ) {
/** /**
* Updates the `blog_public` option for a given site ID. * Updates the `blog_public` option for a given site ID.
* *
* @since 5.0.0 * @since 5.1.0
* *
* @param int $site_id Site ID. * @param int $site_id Site ID.
* @param string $public The value of the site status. * @param string $public The value of the site status.

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

@ -559,7 +559,7 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
* the new blog's ID. It is the first step in creating a new blog. * the new blog's ID. It is the first step in creating a new blog.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @deprecated 5.0.0 Use `wp_insert_site()` * @deprecated 5.1.0 Use `wp_insert_site()`
* @see wp_insert_site() * @see wp_insert_site()
* *
* @param string $domain The domain of the new site. * @param string $domain The domain of the new site.
@ -568,7 +568,7 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
* @return int|false The ID of the new row * @return int|false The ID of the new row
*/ */
function insert_blog($domain, $path, $site_id) { function insert_blog($domain, $path, $site_id) {
_deprecated_function( __FUNCTION__, '5.0.0', 'wp_insert_site()' ); _deprecated_function( __FUNCTION__, '5.1.0', 'wp_insert_site()' );
$data = array( $data = array(
'domain' => $domain, 'domain' => $domain,
@ -594,7 +594,7 @@ function insert_blog($domain, $path, $site_id) {
* points to the new blog. * points to the new blog.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @deprecated 5.0.0 * @deprecated 5.1.0
* *
* @global wpdb $wpdb * @global wpdb $wpdb
* @global WP_Roles $wp_roles * @global WP_Roles $wp_roles
@ -605,7 +605,7 @@ function insert_blog($domain, $path, $site_id) {
function install_blog( $blog_id, $blog_title = '' ) { function install_blog( $blog_id, $blog_title = '' ) {
global $wpdb, $wp_roles; global $wpdb, $wp_roles;
_deprecated_function( __FUNCTION__, '5.0.0' ); _deprecated_function( __FUNCTION__, '5.1.0' );
// Cast for security // Cast for security
$blog_id = (int) $blog_id; $blog_id = (int) $blog_id;

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

@ -1347,7 +1347,7 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $options = array(),
* the notification email. * the notification email.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @since 5.0.0 $blog_id now supports input from the {@see 'wp_initialize_site'} action. * @since 5.1.0 $blog_id now supports input from the {@see 'wp_initialize_site'} action.
* *
* @param WP_Site|int $blog_id The new site's object or ID. * @param WP_Site|int $blog_id The new site's object or ID.
* @param string $deprecated Not used. * @param string $deprecated Not used.
@ -1899,7 +1899,7 @@ function update_posts_count( $deprecated = '' ) {
* Logs the user email, IP, and registration date of a new site. * Logs the user email, IP, and registration date of a new site.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @since 5.0.0 Parameters now support input from the {@see 'wp_initialize_site'} action. * @since 5.1.0 Parameters now support input from the {@see 'wp_initialize_site'} action.
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.1-alpha-44468'; $wp_version = '5.1-alpha-44469';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.