wp_update_site( int $site_id, array $data ): int|WP_Error
Updates a site in the database.
Parameters
-
$site_id
int Required -
ID of the site that should be updated.
-
$data
array Required -
Site data to update. See wp_insert_site() for the list of supported keys.
More Arguments from wp_insert_site( ... $data )
Data for the new site that should be inserted.
domain
stringSite domain. Default empty string.path
stringSite path. Default'/'
.network_id
intThe site's network ID. Default is the current network ID.registered
stringWhen the site was registered, in SQL datetime format. Default is the current time.last_updated
stringWhen the site was last updated, in SQL datetime format. Default is the value of $registered.public
intWhether the site is public. Default 1.archived
intWhether the site is archived. Default 0.mature
intWhether the site is mature. Default 0.spam
intWhether the site is spam. Default 0.deleted
intWhether the site is deleted. Default 0.lang_id
intThe site's language ID. Currently unused. Default 0.user_id
intUser ID for the site administrator. Passed to thewp_initialize_site
hook.title
stringSite title. Default is 'Site %d' where %d is the site ID. Passed to thewp_initialize_site
hook.options
arrayCustom option $key => $value pairs to use. Default empty array. Passed to thewp_initialize_site
hook.meta
arrayCustom site metadata $key => $value pairs to use. Default empty array.
Passed to thewp_initialize_site
hook.
Return
int|WP_Error The updated site's ID on success, or error object on failure.
Source
File: wp-includes/ms-site.php
.
View all references
function wp_update_site( $site_id, array $data ) {
global $wpdb;
if ( empty( $site_id ) ) {
return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) );
}
$old_site = get_site( $site_id );
if ( ! $old_site ) {
return new WP_Error( 'site_not_exist', __( 'Site does not exist.' ) );
}
$defaults = $old_site->to_array();
$defaults['network_id'] = (int) $defaults['site_id'];
$defaults['last_updated'] = current_time( 'mysql', true );
unset( $defaults['blog_id'], $defaults['site_id'] );
$data = wp_prepare_site_data( $data, $defaults, $old_site );
if ( is_wp_error( $data ) ) {
return $data;
}
if ( false === $wpdb->update( $wpdb->blogs, $data, array( 'blog_id' => $old_site->id ) ) ) {
return new WP_Error( 'db_update_error', __( 'Could not update site in the database.' ), $wpdb->last_error );
}
clean_blog_cache( $old_site );
$new_site = get_site( $old_site->id );
/**
* Fires once a site has been updated in the database.
*
* @since 5.1.0
*
* @param WP_Site $new_site New site object.
* @param WP_Site $old_site Old site object.
*/
do_action( 'wp_update_site', $new_site, $old_site );
return (int) $new_site->id;
}
Hooks
-
do_action( 'wp_update_site',
WP_Site $new_site ,WP_Site $old_site ) -
Fires once a site has been updated in the database.
Changelog
Version | Description |
---|---|
5.1.0 | Introduced. |