| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Site API 4 * 5 * @package WordPress 6 * @subpackage Multisite 7 * @since 5.1.0 8 */ 9 10 /** 11 * Inserts a new site into the database. 12 * 13 * @since 5.1.0 14 * 15 * @global wpdb $wpdb WordPress database abstraction object. 16 * 17 * @param array $data { 18 * Data for the new site that should be inserted. 19 * 20 * @type string $domain Site domain. Default empty string. 21 * @type string $path Site path. Default '/'. 22 * @type int $network_id The site's network ID. Default is the current network ID. 23 * @type string $registered When the site was registered, in SQL datetime format. Default is 24 * the current time. 25 * @type string $last_updated When the site was last updated, in SQL datetime format. Default is 26 * the value of $registered. 27 * @type int $public Whether the site is public. Default 1. 28 * @type int $archived Whether the site is archived. Default 0. 29 * @type int $mature Whether the site is mature. Default 0. 30 * @type int $spam Whether the site is spam. Default 0. 31 * @type int $deleted Whether the site is deleted. Default 0. 32 * @type int $lang_id The site's language ID. Currently unused. Default 0. 33 * @type int $user_id User ID for the site administrator. Passed to the 34 * `wp_initialize_site` hook. 35 * @type string $title Site title. Default is 'Site %d' where %d is the site ID. Passed 36 * to the `wp_initialize_site` hook. 37 * @type array $options Custom option $key => $value pairs to use. Default empty array. Passed 38 * to the `wp_initialize_site` hook. 39 * @type array $meta Custom site metadata $key => $value pairs to use. Default empty array. 40 * Passed to the `wp_initialize_site` hook. 41 * } 42 * @return int|WP_Error The new site's ID on success, or error object on failure. 43 */ 44 function wp_insert_site( array $data ) { 45 global $wpdb; 46 47 $now = current_time( 'mysql', true ); 48 49 $defaults = array( 50 'domain' => '', 51 'path' => '/', 52 'network_id' => get_current_network_id(), 53 'registered' => $now, 54 'last_updated' => $now, 55 'public' => 1, 56 'archived' => 0, 57 'mature' => 0, 58 'spam' => 0, 59 'deleted' => 0, 60 'lang_id' => 0, 61 ); 62 63 $prepared_data = wp_prepare_site_data( $data, $defaults ); 64 if ( is_wp_error( $prepared_data ) ) { 65 return $prepared_data; 66 } 67 68 if ( false === $wpdb->insert( $wpdb->blogs, $prepared_data ) ) { 69 return new WP_Error( 'db_insert_error', __( 'Could not insert site into the database.' ), $wpdb->last_error ); 70 } 71 72 $site_id = (int) $wpdb->insert_id; 73 74 clean_blog_cache( $site_id ); 75 76 $new_site = get_site( $site_id ); 77 78 if ( ! $new_site ) { 79 return new WP_Error( 'get_site_error', __( 'Could not retrieve site data.' ) ); 80 } 81 82 /** 83 * Fires once a site has been inserted into the database. 84 * 85 * @since 5.1.0 86 * 87 * @param WP_Site $new_site New site object. 88 */ 89 do_action( 'wp_insert_site', $new_site ); 90 91 // Extract the passed arguments that may be relevant for site initialization. 92 $args = array_diff_key( $data, $defaults ); 93 if ( isset( $args['site_id'] ) ) { 94 unset( $args['site_id'] ); 95 } 96 97 /** 98 * Fires when a site's initialization routine should be executed. 99 * 100 * @since 5.1.0 101 * 102 * @param WP_Site $new_site New site object. 103 * @param array $args Arguments for the initialization. 104 */ 105 do_action( 'wp_initialize_site', $new_site, $args ); 106 107 // Only compute extra hook parameters if the deprecated hook is actually in use. 108 if ( has_action( 'wpmu_new_blog' ) ) { 109 $user_id = ! empty( $args['user_id'] ) ? $args['user_id'] : 0; 110 $meta = ! empty( $args['options'] ) ? $args['options'] : array(); 111 112 // WPLANG was passed with `$meta` to the `wpmu_new_blog` hook prior to 5.1.0. 113 if ( ! array_key_exists( 'WPLANG', $meta ) ) { 114 $meta['WPLANG'] = get_network_option( $new_site->network_id, 'WPLANG' ); 115 } 116 117 /* 118 * Rebuild the data expected by the `wpmu_new_blog` hook prior to 5.1.0 using allowed keys. 119 * The `$allowed_data_fields` matches the one used in `wpmu_create_blog()`. 120 */ 121 $allowed_data_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ); 122 $meta = array_merge( array_intersect_key( $data, array_flip( $allowed_data_fields ) ), $meta ); 123 124 /** 125 * Fires immediately after a new site is created. 126 * 127 * @since MU (3.0.0) 128 * @deprecated 5.1.0 Use {@see 'wp_initialize_site'} instead. 129 * 130 * @param int $site_id Site ID. 131 * @param int $user_id User ID. 132 * @param string $domain Site domain. 133 * @param string $path Site path. 134 * @param int $network_id Network ID. Only relevant on multi-network installations. 135 * @param array $meta Meta data. Used to set initial site options. 136 */ 137 do_action_deprecated( 138 'wpmu_new_blog', 139 array( $new_site->id, $user_id, $new_site->domain, $new_site->path, $new_site->network_id, $meta ), 140 '5.1.0', 141 'wp_initialize_site' 142 ); 143 } 144 145 return (int) $new_site->id; 146 } 147 148 /** 149 * Updates a site in the database. 150 * 151 * @since 5.1.0 152 * 153 * @global wpdb $wpdb WordPress database abstraction object. 154 * 155 * @param int $site_id ID of the site that should be updated. 156 * @param array $data Site data to update. See {@see wp_insert_site()} for the list of supported keys. 157 * @return int|WP_Error The updated site's ID on success, or error object on failure. 158 */ 159 function wp_update_site( $site_id, array $data ) { 160 global $wpdb; 161 162 if ( empty( $site_id ) ) { 163 return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) ); 164 } 165 166 $old_site = get_site( $site_id ); 167 if ( ! $old_site ) { 168 return new WP_Error( 'site_not_exist', __( 'Site does not exist.' ) ); 169 } 170 171 $defaults = $old_site->to_array(); 172 $defaults['network_id'] = (int) $defaults['site_id']; 173 $defaults['last_updated'] = current_time( 'mysql', true ); 174 unset( $defaults['blog_id'], $defaults['site_id'] ); 175 176 $data = wp_prepare_site_data( $data, $defaults, $old_site ); 177 if ( is_wp_error( $data ) ) { 178 return $data; 179 } 180 181 if ( false === $wpdb->update( $wpdb->blogs, $data, array( 'blog_id' => $old_site->id ) ) ) { 182 return new WP_Error( 'db_update_error', __( 'Could not update site in the database.' ), $wpdb->last_error ); 183 } 184 185 clean_blog_cache( $old_site ); 186 187 $new_site = get_site( $old_site->id ); 188 189 /** 190 * Fires once a site has been updated in the database. 191 * 192 * @since 5.1.0 193 * 194 * @param WP_Site $new_site New site object. 195 * @param WP_Site $old_site Old site object. 196 */ 197 do_action( 'wp_update_site', $new_site, $old_site ); 198 199 return (int) $new_site->id; 200 } 201 202 /** 203 * Deletes a site from the database. 204 * 205 * @since 5.1.0 206 * 207 * @global wpdb $wpdb WordPress database abstraction object. 208 * 209 * @param int $site_id ID of the site that should be deleted. 210 * @return WP_Site|WP_Error The deleted site object on success, or error object on failure. 211 */ 212 function wp_delete_site( $site_id ) { 213 global $wpdb; 214 215 if ( empty( $site_id ) ) { 216 return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) ); 217 } 218 219 $old_site = get_site( $site_id ); 220 if ( ! $old_site ) { 221 return new WP_Error( 'site_not_exist', __( 'Site does not exist.' ) ); 222 } 223 224 $errors = new WP_Error(); 225 226 /** 227 * Fires before a site should be deleted from the database. 228 * 229 * Plugins should amend the `$errors` object via its `WP_Error::add()` method. If any errors 230 * are present, the site will not be deleted. 231 * 232 * @since 5.1.0 233 * 234 * @param WP_Error $errors Error object to add validation errors to. 235 * @param WP_Site $old_site The site object to be deleted. 236 */ 237 do_action( 'wp_validate_site_deletion', $errors, $old_site ); 238 239 if ( ! empty( $errors->errors ) ) { 240 return $errors; 241 } 242 243 /** 244 * Fires before a site is deleted. 245 * 246 * @since MU (3.0.0) 247 * @deprecated 5.1.0 248 * 249 * @param int $site_id The site ID. 250 * @param bool $drop True if site's table should be dropped. Default false. 251 */ 252 do_action_deprecated( 'delete_blog', array( $old_site->id, true ), '5.1.0' ); 253 254 /** 255 * Fires when a site's uninitialization routine should be executed. 256 * 257 * @since 5.1.0 258 * 259 * @param WP_Site $old_site Deleted site object. 260 */ 261 do_action( 'wp_uninitialize_site', $old_site ); 262 263 if ( is_site_meta_supported() ) { 264 $blog_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->blogmeta WHERE blog_id = %d ", $old_site->id ) ); 265 foreach ( $blog_meta_ids as $mid ) { 266 delete_metadata_by_mid( 'blog', $mid ); 267 } 268 } 269 270 if ( false === $wpdb->delete( $wpdb->blogs, array( 'blog_id' => $old_site->id ) ) ) { 271 return new WP_Error( 'db_delete_error', __( 'Could not delete site from the database.' ), $wpdb->last_error ); 272 } 273 274 clean_blog_cache( $old_site ); 275 276 /** 277 * Fires once a site has been deleted from the database. 278 * 279 * @since 5.1.0 280 * 281 * @param WP_Site $old_site Deleted site object. 282 */ 283 do_action( 'wp_delete_site', $old_site ); 284 285 /** 286 * Fires after the site is deleted from the network. 287 * 288 * @since 4.8.0 289 * @deprecated 5.1.0 290 * 291 * @param int $site_id The site ID. 292 * @param bool $drop True if site's tables should be dropped. Default false. 293 */ 294 do_action_deprecated( 'deleted_blog', array( $old_site->id, true ), '5.1.0' ); 295 296 return $old_site; 297 } 298 299 /** 300 * Retrieves site data given a site ID or site object. 301 * 302 * Site data will be cached and returned after being passed through a filter. 303 * If the provided site is empty, the current site global will be used. 304 * 305 * @since 4.6.0 306 * 307 * @param WP_Site|int|null $site Optional. Site to retrieve. Default is the current site. 308 * @return WP_Site|null The site object or null if not found. 309 */ 310 function get_site( $site = null ) { 311 if ( empty( $site ) ) { 312 $site = get_current_blog_id(); 313 } 314 315 if ( $site instanceof WP_Site ) { 316 $_site = $site; 317 } elseif ( is_object( $site ) ) { 318 $_site = new WP_Site( $site ); 319 } else { 320 $_site = WP_Site::get_instance( $site ); 321 } 322 323 if ( ! $_site ) { 324 return null; 325 } 326 327 /** 328 * Fires after a site is retrieved. 329 * 330 * @since 4.6.0 331 * 332 * @param WP_Site $_site Site data. 333 */ 334 $_site = apply_filters( 'get_site', $_site ); 335 336 return $_site; 337 } 338 339 /** 340 * Adds any sites from the given IDs to the cache that do not already exist in cache. 341 * 342 * @since 4.6.0 343 * @since 5.1.0 Introduced the `$update_meta_cache` parameter. 344 * @since 6.1.0 This function is no longer marked as "private". 345 * @since 6.3.0 Use wp_lazyload_site_meta() for lazy-loading of site meta. 346 * 347 * @see update_site_cache() 348 * @global wpdb $wpdb WordPress database abstraction object. 349 * 350 * @param array $ids ID list. 351 * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. 352 */ 353 function _prime_site_caches( $ids, $update_meta_cache = true ) { 354 global $wpdb; 355 356 $non_cached_ids = _get_non_cached_ids( $ids, 'sites' ); 357 if ( ! empty( $non_cached_ids ) ) { 358 $fresh_sites = $wpdb->get_results( sprintf( "SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared 359 360 update_site_cache( $fresh_sites, false ); 361 } 362 363 if ( $update_meta_cache ) { 364 wp_lazyload_site_meta( $ids ); 365 } 366 } 367 368 /** 369 * Queue site meta for lazy-loading. 370 * 371 * @since 6.3.0 372 * 373 * @param array $site_ids List of site IDs. 374 */ 375 function wp_lazyload_site_meta( array $site_ids ) { 376 if ( empty( $site_ids ) ) { 377 return; 378 } 379 $lazyloader = wp_metadata_lazyloader(); 380 $lazyloader->queue_objects( 'blog', $site_ids ); 381 } 382 383 /** 384 * Updates sites in cache. 385 * 386 * @since 4.6.0 387 * @since 5.1.0 Introduced the `$update_meta_cache` parameter. 388 * 389 * @param array $sites Array of site objects. 390 * @param bool $update_meta_cache Whether to update site meta cache. Default true. 391 */ 392 function update_site_cache( $sites, $update_meta_cache = true ) { 393 if ( ! $sites ) { 394 return; 395 } 396 $site_ids = array(); 397 $site_data = array(); 398 $blog_details_data = array(); 399 foreach ( $sites as $site ) { 400 $site_ids[] = $site->blog_id; 401 $site_data[ $site->blog_id ] = $site; 402 $blog_details_data[ $site->blog_id . 'short' ] = $site; 403 404 } 405 wp_cache_add_multiple( $site_data, 'sites' ); 406 wp_cache_add_multiple( $blog_details_data, 'blog-details' ); 407 408 if ( $update_meta_cache ) { 409 update_sitemeta_cache( $site_ids ); 410 } 411 } 412 413 /** 414 * Updates metadata cache for list of site IDs. 415 * 416 * Performs SQL query to retrieve all metadata for the sites matching `$site_ids` and stores them in the cache. 417 * Subsequent calls to `get_site_meta()` will not need to query the database. 418 * 419 * @since 5.1.0 420 * 421 * @param array $site_ids List of site IDs. 422 * @return array|false An array of metadata on success, false if there is nothing to update. 423 */ 424 function update_sitemeta_cache( $site_ids ) { 425 // Ensure this filter is hooked in even if the function is called early. 426 if ( ! has_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' ) ) { 427 add_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' ); 428 } 429 return update_meta_cache( 'blog', $site_ids ); 430 } 431 432 /** 433 * Retrieves a list of sites matching requested arguments. 434 * 435 * @since 4.6.0 436 * @since 4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters. 437 * 438 * @see WP_Site_Query::parse_query() 439 * 440 * @param string|array $args Optional. Array or string of arguments. See WP_Site_Query::__construct() 441 * for information on accepted arguments. Default empty array. 442 * @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids', 443 * or the number of sites when 'count' is passed as a query var. 444 */ 445 function get_sites( $args = array() ) { 446 $query = new WP_Site_Query(); 447 448 return $query->query( $args ); 449 } 450 451 /** 452 * Prepares site data for insertion or update in the database. 453 * 454 * @since 5.1.0 455 * 456 * @param array $data Associative array of site data passed to the respective function. 457 * See {@see wp_insert_site()} for the possibly included data. 458 * @param array $defaults Site data defaults to parse $data against. 459 * @param WP_Site|null $old_site Optional. Old site object if an update, or null if an insertion. 460 * Default null. 461 * @return array|WP_Error Site data ready for a database transaction, or WP_Error in case a validation 462 * error occurred. 463 */ 464 function wp_prepare_site_data( $data, $defaults, $old_site = null ) { 465 466 // Maintain backward-compatibility with `$site_id` as network ID. 467 if ( isset( $data['site_id'] ) ) { 468 if ( ! empty( $data['site_id'] ) && empty( $data['network_id'] ) ) { 469 $data['network_id'] = $data['site_id']; 470 } 471 unset( $data['site_id'] ); 472 } 473 474 /** 475 * Filters passed site data in order to normalize it. 476 * 477 * @since 5.1.0 478 * 479 * @param array $data Associative array of site data passed to the respective function. 480 * See {@see wp_insert_site()} for the possibly included data. 481 */ 482 $data = apply_filters( 'wp_normalize_site_data', $data ); 483 484 $allowed_data_fields = array( 'domain', 'path', 'network_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ); 485 $data = array_intersect_key( wp_parse_args( $data, $defaults ), array_flip( $allowed_data_fields ) ); 486 487 $errors = new WP_Error(); 488 489 /** 490 * Fires when data should be validated for a site prior to inserting or updating in the database. 491 * 492 * Plugins should amend the `$errors` object via its `WP_Error::add()` method. 493 * 494 * @since 5.1.0 495 * 496 * @param WP_Error $errors Error object to add validation errors to. 497 * @param array $data Associative array of complete site data. See {@see wp_insert_site()} 498 * for the included data. 499 * @param WP_Site|null $old_site The old site object if the data belongs to a site being updated, 500 * or null if it is a new site being inserted. 501 */ 502 do_action( 'wp_validate_site_data', $errors, $data, $old_site ); 503 504 if ( ! empty( $errors->errors ) ) { 505 return $errors; 506 } 507 508 // Prepare for database. 509 $data['site_id'] = $data['network_id']; 510 unset( $data['network_id'] ); 511 512 return $data; 513 } 514 515 /** 516 * Normalizes data for a site prior to inserting or updating in the database. 517 * 518 * @since 5.1.0 519 * 520 * @param array $data Associative array of site data passed to the respective function. 521 * See {@see wp_insert_site()} for the possibly included data. 522 * @return array Normalized site data. 523 */ 524 function wp_normalize_site_data( $data ) { 525 // Sanitize domain if passed. 526 if ( array_key_exists( 'domain', $data ) ) { 527 $data['domain'] = trim( $data['domain'] ); 528 $data['domain'] = preg_replace( '/\s+/', '', sanitize_user( $data['domain'], true ) ); 529 if ( is_subdomain_install() ) { 530 $data['domain'] = str_replace( '@', '', $data['domain'] ); 531 } 532 } 533 534 // Sanitize path if passed. 535 if ( array_key_exists( 'path', $data ) ) { 536 $data['path'] = trailingslashit( '/' . trim( $data['path'], '/' ) ); 537 } 538 539 // Sanitize network ID if passed. 540 if ( array_key_exists( 'network_id', $data ) ) { 541 $data['network_id'] = (int) $data['network_id']; 542 } 543 544 // Sanitize status fields if passed. 545 $status_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted' ); 546 foreach ( $status_fields as $status_field ) { 547 if ( array_key_exists( $status_field, $data ) ) { 548 $data[ $status_field ] = (int) $data[ $status_field ]; 549 } 550 } 551 552 // Strip date fields if empty. 553 $date_fields = array( 'registered', 'last_updated' ); 554 foreach ( $date_fields as $date_field ) { 555 if ( ! array_key_exists( $date_field, $data ) ) { 556 continue; 557 } 558 559 if ( empty( $data[ $date_field ] ) || '0000-00-00 00:00:00' === $data[ $date_field ] ) { 560 unset( $data[ $date_field ] ); 561 } 562 } 563 564 return $data; 565 } 566 567 /** 568 * Validates data for a site prior to inserting or updating in the database. 569 * 570 * @since 5.1.0 571 * 572 * @param WP_Error $errors Error object, passed by reference. Will contain validation errors if 573 * any occurred. 574 * @param array $data Associative array of complete site data. See {@see wp_insert_site()} 575 * for the included data. 576 * @param WP_Site|null $old_site The old site object if the data belongs to a site being updated, 577 * or null if it is a new site being inserted. 578 */ 579 function wp_validate_site_data( $errors, $data, $old_site = null ) { 580 // A domain must always be present. 581 if ( empty( $data['domain'] ) ) { 582 $errors->add( 'site_empty_domain', __( 'Site domain must not be empty.' ) ); 583 } 584 585 // A path must always be present. 586 if ( empty( $data['path'] ) ) { 587 $errors->add( 'site_empty_path', __( 'Site path must not be empty.' ) ); 588 } 589 590 // A network ID must always be present. 591 if ( empty( $data['network_id'] ) ) { 592 $errors->add( 'site_empty_network_id', __( 'Site network ID must be provided.' ) ); 593 } 594 595 // Both registration and last updated dates must always be present and valid. 596 $date_fields = array( 'registered', 'last_updated' ); 597 foreach ( $date_fields as $date_field ) { 598 if ( empty( $data[ $date_field ] ) ) { 599 $errors->add( 'site_empty_' . $date_field, __( 'Both registration and last updated dates must be provided.' ) ); 600 break; 601 } 602 603 // Allow '0000-00-00 00:00:00', although it be stripped out at this point. 604 if ( '0000-00-00 00:00:00' !== $data[ $date_field ] ) { 605 $month = substr( $data[ $date_field ], 5, 2 ); 606 $day = substr( $data[ $date_field ], 8, 2 ); 607 $year = substr( $data[ $date_field ], 0, 4 ); 608 $valid_date = wp_checkdate( $month, $day, $year, $data[ $date_field ] ); 609 if ( ! $valid_date ) { 610 $errors->add( 'site_invalid_' . $date_field, __( 'Both registration and last updated dates must be valid dates.' ) ); 611 break; 612 } 613 } 614 } 615 616 if ( ! empty( $errors->errors ) ) { 617 return; 618 } 619 620 // If a new site, or domain/path/network ID have changed, ensure uniqueness. 621 if ( ! $old_site 622 || $data['domain'] !== $old_site->domain 623 || $data['path'] !== $old_site->path 624 || $data['network_id'] !== $old_site->network_id 625 ) { 626 if ( domain_exists( $data['domain'], $data['path'], $data['network_id'] ) ) { 627 $errors->add( 'site_taken', __( 'Sorry, that site already exists!' ) ); 628 } 629 } 630 } 631 632 /** 633 * Runs the initialization routine for a given site. 634 * 635 * This process includes creating the site's database tables and 636 * populating them with defaults. 637 * 638 * @since 5.1.0 639 * 640 * @global wpdb $wpdb WordPress database abstraction object. 641 * @global WP_Roles $wp_roles WordPress role management object. 642 * 643 * @param int|WP_Site $site_id Site ID or object. 644 * @param array $args { 645 * Optional. Arguments to modify the initialization behavior. 646 * 647 * @type int $user_id Required. User ID for the site administrator. 648 * @type string $title Site title. Default is 'Site %d' where %d is the 649 * site ID. 650 * @type array $options Custom option $key => $value pairs to use. Default 651 * empty array. 652 * @type array $meta Custom site metadata $key => $value pairs to use. 653 * Default empty array. 654 * } 655 * @return true|WP_Error True on success, or error object on failure. 656 */ 657 function wp_initialize_site( $site_id, array $args = array() ) { 658 global $wpdb, $wp_roles; 659 660 if ( empty( $site_id ) ) { 661 return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) ); 662 } 663 664 $site = get_site( $site_id ); 665 if ( ! $site ) { 666 return new WP_Error( 'site_invalid_id', __( 'Site with the ID does not exist.' ) ); 667 } 668 669 if ( wp_is_site_initialized( $site ) ) { 670 return new WP_Error( 'site_already_initialized', __( 'The site appears to be already initialized.' ) ); 671 } 672 673 $network = get_network( $site->network_id ); 674 if ( ! $network ) { 675 $network = get_network(); 676 } 677 678 $args = wp_parse_args( 679 $args, 680 array( 681 'user_id' => 0, 682 /* translators: %d: Site ID. */ 683 'title' => sprintf( __( 'Site %d' ), $site->id ), 684 'options' => array(), 685 'meta' => array(), 686 ) 687 ); 688 689 /** 690 * Filters the arguments for initializing a site. 691 * 692 * @since 5.1.0 693 * 694 * @param array $args Arguments to modify the initialization behavior. 695 * @param WP_Site $site Site that is being initialized. 696 * @param WP_Network $network Network that the site belongs to. 697 */ 698 $args = apply_filters( 'wp_initialize_site_args', $args, $site, $network ); 699 700 $orig_installing = wp_installing(); 701 if ( ! $orig_installing ) { 702 wp_installing( true ); 703 } 704 705 $switch = false; 706 if ( get_current_blog_id() !== $site->id ) { 707 $switch = true; 708 switch_to_blog( $site->id ); 709 } 710 711 require_once ABSPATH . 'wp-admin/includes/upgrade.php'; 712 713 // Set up the database tables. 714 make_db_current_silent( 'blog' ); 715 716 $home_scheme = 'http'; 717 $siteurl_scheme = 'http'; 718 if ( ! is_subdomain_install() ) { 719 if ( 'https' === parse_url( get_home_url( $network->site_id ), PHP_URL_SCHEME ) ) { 720 $home_scheme = 'https'; 721 } 722 if ( 'https' === parse_url( get_network_option( $network->id, 'siteurl' ), PHP_URL_SCHEME ) ) { 723 $siteurl_scheme = 'https'; 724 } 725 } 726 727 // Populate the site's options. 728 populate_options( 729 array_merge( 730 array( 731 'home' => untrailingslashit( $home_scheme . '://' . $site->domain . $site->path ), 732 'siteurl' => untrailingslashit( $siteurl_scheme . '://' . $site->domain . $site->path ), 733 'blogname' => wp_unslash( $args['title'] ), 734 'admin_email' => '', 735 'upload_path' => get_network_option( $network->id, 'ms_files_rewriting' ) ? UPLOADBLOGSDIR . "/{$site->id}/files" : get_blog_option( $network->site_id, 'upload_path' ), 736 'blog_public' => (int) $site->public, 737 'WPLANG' => get_network_option( $network->id, 'WPLANG' ), 738 ), 739 $args['options'] 740 ) 741 ); 742 743 // Clean blog cache after populating options. 744 clean_blog_cache( $site ); 745 746 // Populate the site's roles. 747 populate_roles(); 748 $wp_roles = new WP_Roles(); 749 750 // Populate metadata for the site. 751 populate_site_meta( $site->id, $args['meta'] ); 752 753 // Remove all permissions that may exist for the site. 754 $table_prefix = $wpdb->get_blog_prefix(); 755 delete_metadata( 'user', 0, $table_prefix . 'user_level', null, true ); // Delete all. 756 delete_metadata( 'user', 0, $table_prefix . 'capabilities', null, true ); // Delete all. 757 758 // Install default site content. 759 wp_install_defaults( $args['user_id'] ); 760 761 // Set the site administrator. 762 add_user_to_blog( $site->id, $args['user_id'], 'administrator' ); 763 if ( ! user_can( $args['user_id'], 'manage_network' ) && ! get_user_meta( $args['user_id'], 'primary_blog', true ) ) { 764 update_user_meta( $args['user_id'], 'primary_blog', $site->id ); 765 } 766 767 if ( $switch ) { 768 restore_current_blog(); 769 } 770 771 wp_installing( $orig_installing ); 772 773 return true; 774 } 775 776 /** 777 * Runs the uninitialization routine for a given site. 778 * 779 * This process includes dropping the site's database tables and deleting its uploads directory. 780 * 781 * @since 5.1.0 782 * 783 * @global wpdb $wpdb WordPress database abstraction object. 784 * 785 * @param int|WP_Site $site_id Site ID or object. 786 * @return true|WP_Error True on success, or error object on failure. 787 */ 788 function wp_uninitialize_site( $site_id ) { 789 global $wpdb; 790 791 if ( empty( $site_id ) ) { 792 return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) ); 793 } 794 795 $site = get_site( $site_id ); 796 if ( ! $site ) { 797 return new WP_Error( 'site_invalid_id', __( 'Site with the ID does not exist.' ) ); 798 } 799 800 if ( ! wp_is_site_initialized( $site ) ) { 801 return new WP_Error( 'site_already_uninitialized', __( 'The site appears to be already uninitialized.' ) ); 802 } 803 804 $users = get_users( 805 array( 806 'blog_id' => $site->id, 807 'fields' => 'ids', 808 ) 809 ); 810 811 // Remove users from the site. 812 if ( ! empty( $users ) ) { 813 foreach ( $users as $user_id ) { 814 remove_user_from_blog( $user_id, $site->id ); 815 } 816 } 817 818 $switch = false; 819 if ( get_current_blog_id() !== $site->id ) { 820 $switch = true; 821 switch_to_blog( $site->id ); 822 } 823 824 $uploads = wp_get_upload_dir(); 825 826 $tables = $wpdb->tables( 'blog' ); 827 828 /** 829 * Filters the tables to drop when the site is deleted. 830 * 831 * @since MU (3.0.0) 832 * 833 * @param string[] $tables Array of names of the site tables to be dropped. 834 * @param int $site_id The ID of the site to drop tables for. 835 */ 836 $drop_tables = apply_filters( 'wpmu_drop_tables', $tables, $site->id ); 837 838 foreach ( (array) $drop_tables as $table ) { 839 $wpdb->query( "DROP TABLE IF EXISTS `$table`" ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared 840 } 841 842 /** 843 * Filters the upload base directory to delete when the site is deleted. 844 * 845 * @since MU (3.0.0) 846 * 847 * @param string $basedir Uploads path without subdirectory. See {@see wp_upload_dir()}. 848 * @param int $site_id The site ID. 849 */ 850 $dir = apply_filters( 'wpmu_delete_blog_upload_dir', $uploads['basedir'], $site->id ); 851 $dir = rtrim( $dir, DIRECTORY_SEPARATOR ); 852 $top_dir = $dir; 853 $stack = array( $dir ); 854 $index = 0; 855 856 while ( $index < count( $stack ) ) { 857 // Get indexed directory from stack. 858 $dir = $stack[ $index ]; 859 860 // phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged 861 $dh = @opendir( $dir ); 862 if ( $dh ) { 863 $file = @readdir( $dh ); 864 while ( false !== $file ) { 865 if ( '.' === $file || '..' === $file ) { 866 $file = @readdir( $dh ); 867 continue; 868 } 869 870 if ( @is_dir( $dir . DIRECTORY_SEPARATOR . $file ) ) { 871 $stack[] = $dir . DIRECTORY_SEPARATOR . $file; 872 } elseif ( @is_file( $dir . DIRECTORY_SEPARATOR . $file ) ) { 873 @unlink( $dir . DIRECTORY_SEPARATOR . $file ); 874 } 875 876 $file = @readdir( $dh ); 877 } 878 @closedir( $dh ); 879 } 880 ++$index; 881 } 882 883 $stack = array_reverse( $stack ); // Last added directories are deepest. 884 foreach ( (array) $stack as $dir ) { 885 if ( $dir !== $top_dir ) { 886 @rmdir( $dir ); 887 } 888 } 889 890 // phpcs:enable WordPress.PHP.NoSilencedErrors.Discouraged 891 if ( $switch ) { 892 restore_current_blog(); 893 } 894 895 return true; 896 } 897 898 /** 899 * Checks whether a site is initialized. 900 * 901 * A site is considered initialized when its database tables are present. 902 * 903 * @since 5.1.0 904 * 905 * @global wpdb $wpdb WordPress database abstraction object. 906 * 907 * @param int|WP_Site $site_id Site ID or object. 908 * @return bool True if the site is initialized, false otherwise. 909 */ 910 function wp_is_site_initialized( $site_id ) { 911 global $wpdb; 912 913 if ( is_object( $site_id ) ) { 914 $site_id = $site_id->blog_id; 915 } 916 $site_id = (int) $site_id; 917 918 /** 919 * Filters the check for whether a site is initialized before the database is accessed. 920 * 921 * Returning a non-null value will effectively short-circuit the function, returning 922 * that value instead. 923 * 924 * @since 5.1.0 925 * 926 * @param bool|null $pre The value to return instead. Default null 927 * to continue with the check. 928 * @param int $site_id The site ID that is being checked. 929 */ 930 $pre = apply_filters( 'pre_wp_is_site_initialized', null, $site_id ); 931 if ( null !== $pre ) { 932 return (bool) $pre; 933 } 934 935 $switch = false; 936 if ( get_current_blog_id() !== $site_id ) { 937 $switch = true; 938 remove_action( 'switch_blog', 'wp_switch_roles_and_user', 1 ); 939 switch_to_blog( $site_id ); 940 } 941 942 $suppress = $wpdb->suppress_errors(); 943 $result = (bool) $wpdb->get_results( "DESCRIBE {$wpdb->posts}" ); 944 $wpdb->suppress_errors( $suppress ); 945 946 if ( $switch ) { 947 restore_current_blog(); 948 add_action( 'switch_blog', 'wp_switch_roles_and_user', 1, 2 ); 949 } 950 951 return $result; 952 } 953 954 /** 955 * Clean the blog cache 956 * 957 * @since 3.5.0 958 * 959 * @global bool $_wp_suspend_cache_invalidation 960 * 961 * @param WP_Site|int $blog The site object or ID to be cleared from cache. 962 */ 963 function clean_blog_cache( $blog ) { 964 global $_wp_suspend_cache_invalidation; 965 966 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 967 return; 968 } 969 970 if ( empty( $blog ) ) { 971 return; 972 } 973 974 $blog_id = $blog; 975 $blog = get_site( $blog_id ); 976 if ( ! $blog ) { 977 if ( ! is_numeric( $blog_id ) ) { 978 return; 979 } 980 981 // Make sure a WP_Site object exists even when the site has been deleted. 982 $blog = new WP_Site( 983 (object) array( 984 'blog_id' => $blog_id, 985 'domain' => null, 986 'path' => null, 987 ) 988 ); 989 } 990 991 $blog_id = $blog->blog_id; 992 $domain_path_key = md5( $blog->domain . $blog->path ); 993 994 wp_cache_delete( $blog_id, 'sites' ); 995 wp_cache_delete( $blog_id, 'site-details' ); 996 wp_cache_delete( $blog_id, 'blog-details' ); 997 wp_cache_delete( $blog_id . 'short', 'blog-details' ); 998 wp_cache_delete( $domain_path_key, 'blog-lookup' ); 999 wp_cache_delete( $domain_path_key, 'blog-id-cache' ); 1000 wp_cache_delete( $blog_id, 'blog_meta' ); 1001 1002 /** 1003 * Fires immediately after a site has been removed from the object cache. 1004 * 1005 * @since 4.6.0 1006 * 1007 * @param string $id Site ID as a numeric string. 1008 * @param WP_Site $blog Site object. 1009 * @param string $domain_path_key md5 hash of domain and path. 1010 */ 1011 do_action( 'clean_site_cache', $blog_id, $blog, $domain_path_key ); 1012 1013 wp_cache_set_sites_last_changed(); 1014 1015 /** 1016 * Fires after the blog details cache is cleared. 1017 * 1018 * @since 3.4.0 1019 * @deprecated 4.9.0 Use {@see 'clean_site_cache'} instead. 1020 * 1021 * @param int $blog_id Blog ID. 1022 */ 1023 do_action_deprecated( 'refresh_blog_details', array( $blog_id ), '4.9.0', 'clean_site_cache' ); 1024 } 1025 1026 /** 1027 * Adds metadata to a site. 1028 * 1029 * @since 5.1.0 1030 * 1031 * @param int $site_id Site ID. 1032 * @param string $meta_key Metadata name. 1033 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1034 * @param bool $unique Optional. Whether the same key should not be added. 1035 * Default false. 1036 * @return int|false Meta ID on success, false on failure. 1037 */ 1038 function add_site_meta( $site_id, $meta_key, $meta_value, $unique = false ) { 1039 return add_metadata( 'blog', $site_id, $meta_key, $meta_value, $unique ); 1040 } 1041 1042 /** 1043 * Removes metadata matching criteria from a site. 1044 * 1045 * You can match based on the key, or key and value. Removing based on key and 1046 * value, will keep from removing duplicate metadata with the same key. It also 1047 * allows removing all metadata matching key, if needed. 1048 * 1049 * @since 5.1.0 1050 * 1051 * @param int $site_id Site ID. 1052 * @param string $meta_key Metadata name. 1053 * @param mixed $meta_value Optional. Metadata value. If provided, 1054 * rows will only be removed that match the value. 1055 * Must be serializable if non-scalar. Default empty. 1056 * @return bool True on success, false on failure. 1057 */ 1058 function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) { 1059 return delete_metadata( 'blog', $site_id, $meta_key, $meta_value ); 1060 } 1061 1062 /** 1063 * Retrieves metadata for a site. 1064 * 1065 * @since 5.1.0 1066 * 1067 * @param int $site_id Site ID. 1068 * @param string $key Optional. The meta key to retrieve. By default, 1069 * returns data for all keys. Default empty. 1070 * @param bool $single Optional. Whether to return a single value. 1071 * This parameter has no effect if `$key` is not specified. 1072 * Default false. 1073 * @return mixed An array of values if `$single` is false. 1074 * The value of meta data field if `$single` is true. 1075 * False for an invalid `$site_id` (non-numeric, zero, or negative value). 1076 * An empty string if a valid but non-existing site ID is passed. 1077 */ 1078 function get_site_meta( $site_id, $key = '', $single = false ) { 1079 return get_metadata( 'blog', $site_id, $key, $single ); 1080 } 1081 1082 /** 1083 * Updates metadata for a site. 1084 * 1085 * Use the $prev_value parameter to differentiate between meta fields with the 1086 * same key and site ID. 1087 * 1088 * If the meta field for the site does not exist, it will be added. 1089 * 1090 * @since 5.1.0 1091 * 1092 * @param int $site_id Site ID. 1093 * @param string $meta_key Metadata key. 1094 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1095 * @param mixed $prev_value Optional. Previous value to check before updating. 1096 * If specified, only update existing metadata entries with 1097 * this value. Otherwise, update all entries. Default empty. 1098 * @return int|bool Meta ID if the key didn't exist, true on successful update, 1099 * false on failure or if the value passed to the function 1100 * is the same as the one that is already in the database. 1101 */ 1102 function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) { 1103 return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value ); 1104 } 1105 1106 /** 1107 * Deletes everything from site meta matching meta key. 1108 * 1109 * @since 5.1.0 1110 * 1111 * @param string $meta_key Metadata key to search for when deleting. 1112 * @return bool Whether the site meta key was deleted from the database. 1113 */ 1114 function delete_site_meta_by_key( $meta_key ) { 1115 return delete_metadata( 'blog', null, $meta_key, '', true ); 1116 } 1117 1118 /** 1119 * Updates the count of sites for a network based on a changed site. 1120 * 1121 * @since 5.1.0 1122 * 1123 * @param WP_Site $new_site The site object that has been inserted, updated or deleted. 1124 * @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous 1125 * state of that site. Default null. 1126 */ 1127 function wp_maybe_update_network_site_counts_on_update( $new_site, $old_site = null ) { 1128 if ( null === $old_site ) { 1129 wp_maybe_update_network_site_counts( $new_site->network_id ); 1130 return; 1131 } 1132 1133 if ( $new_site->network_id !== $old_site->network_id ) { 1134 wp_maybe_update_network_site_counts( $new_site->network_id ); 1135 wp_maybe_update_network_site_counts( $old_site->network_id ); 1136 } 1137 } 1138 1139 /** 1140 * Triggers actions on site status updates. 1141 * 1142 * @since 5.1.0 1143 * 1144 * @param WP_Site $new_site The site object after the update. 1145 * @param WP_Site|null $old_site Optional. If $new_site has been updated, this must be the previous 1146 * state of that site. Default null. 1147 */ 1148 function wp_maybe_transition_site_statuses_on_update( $new_site, $old_site = null ) { 1149 $site_id = $new_site->id; 1150 1151 // Use the default values for a site if no previous state is given. 1152 if ( ! $old_site ) { 1153 $old_site = new WP_Site( new stdClass() ); 1154 } 1155 1156 if ( $new_site->spam !== $old_site->spam ) { 1157 if ( '1' === $new_site->spam ) { 1158 1159 /** 1160 * Fires when the 'spam' status is added to a site. 1161 * 1162 * @since MU (3.0.0) 1163 * 1164 * @param int $site_id Site ID. 1165 */ 1166 do_action( 'make_spam_blog', $site_id ); 1167 } else { 1168 1169 /** 1170 * Fires when the 'spam' status is removed from a site. 1171 * 1172 * @since MU (3.0.0) 1173 * 1174 * @param int $site_id Site ID. 1175 */ 1176 do_action( 'make_ham_blog', $site_id ); 1177 } 1178 } 1179 1180 if ( $new_site->mature !== $old_site->mature ) { 1181 if ( '1' === $new_site->mature ) { 1182 1183 /** 1184 * Fires when the 'mature' status is added to a site. 1185 * 1186 * @since 3.1.0 1187 * 1188 * @param int $site_id Site ID. 1189 */ 1190 do_action( 'mature_blog', $site_id ); 1191 } else { 1192 1193 /** 1194 * Fires when the 'mature' status is removed from a site. 1195 * 1196 * @since 3.1.0 1197 * 1198 * @param int $site_id Site ID. 1199 */ 1200 do_action( 'unmature_blog', $site_id ); 1201 } 1202 } 1203 1204 if ( $new_site->archived !== $old_site->archived ) { 1205 if ( '1' === $new_site->archived ) { 1206 1207 /** 1208 * Fires when the 'archived' status is added to a site. 1209 * 1210 * @since MU (3.0.0) 1211 * 1212 * @param int $site_id Site ID. 1213 */ 1214 do_action( 'archive_blog', $site_id ); 1215 } else { 1216 1217 /** 1218 * Fires when the 'archived' status is removed from a site. 1219 * 1220 * @since MU (3.0.0) 1221 * 1222 * @param int $site_id Site ID. 1223 */ 1224 do_action( 'unarchive_blog', $site_id ); 1225 } 1226 } 1227 1228 if ( $new_site->deleted !== $old_site->deleted ) { 1229 if ( '1' === $new_site->deleted ) { 1230 1231 /** 1232 * Fires when the 'deleted' status is added to a site. 1233 * 1234 * @since 3.5.0 1235 * 1236 * @param int $site_id Site ID. 1237 */ 1238 do_action( 'make_delete_blog', $site_id ); 1239 } else { 1240 1241 /** 1242 * Fires when the 'deleted' status is removed from a site. 1243 * 1244 * @since 3.5.0 1245 * 1246 * @param int $site_id Site ID. 1247 */ 1248 do_action( 'make_undelete_blog', $site_id ); 1249 } 1250 } 1251 1252 if ( $new_site->public !== $old_site->public ) { 1253 1254 /** 1255 * Fires after the current blog's 'public' setting is updated. 1256 * 1257 * @since MU (3.0.0) 1258 * 1259 * @param int $site_id Site ID. 1260 * @param string $is_public Whether the site is public. A numeric string, 1261 * for compatibility reasons. Accepts '1' or '0'. 1262 */ 1263 do_action( 'update_blog_public', $site_id, $new_site->public ); 1264 } 1265 } 1266 1267 /** 1268 * Cleans the necessary caches after specific site data has been updated. 1269 * 1270 * @since 5.1.0 1271 * 1272 * @param WP_Site $new_site The site object after the update. 1273 * @param WP_Site $old_site The site object prior to the update. 1274 */ 1275 function wp_maybe_clean_new_site_cache_on_update( $new_site, $old_site ) { 1276 if ( $old_site->domain !== $new_site->domain || $old_site->path !== $new_site->path ) { 1277 clean_blog_cache( $new_site ); 1278 } 1279 } 1280 1281 /** 1282 * Updates the `blog_public` option for a given site ID. 1283 * 1284 * @since 5.1.0 1285 * 1286 * @param int $site_id Site ID. 1287 * @param string $is_public Whether the site is public. A numeric string, 1288 * for compatibility reasons. Accepts '1' or '0'. 1289 */ 1290 function wp_update_blog_public_option_on_site_update( $site_id, $is_public ) { 1291 1292 // Bail if the site's database tables do not exist (yet). 1293 if ( ! wp_is_site_initialized( $site_id ) ) { 1294 return; 1295 } 1296 1297 update_blog_option( $site_id, 'blog_public', $is_public ); 1298 } 1299 1300 /** 1301 * Sets the last changed time for the 'sites' cache group. 1302 * 1303 * @since 5.1.0 1304 */ 1305 function wp_cache_set_sites_last_changed() { 1306 wp_cache_set_last_changed( 'sites' ); 1307 } 1308 1309 /** 1310 * Aborts calls to site meta if it is not supported. 1311 * 1312 * @since 5.1.0 1313 * 1314 * @global wpdb $wpdb WordPress database abstraction object. 1315 * 1316 * @param mixed $check Skip-value for whether to proceed site meta function execution. 1317 * @return mixed Original value of $check, or false if site meta is not supported. 1318 */ 1319 function wp_check_site_meta_support_prefilter( $check ) { 1320 if ( ! is_site_meta_supported() ) { 1321 /* translators: %s: Database table name. */ 1322 _doing_it_wrong( __FUNCTION__, sprintf( __( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS['wpdb']->blogmeta ), '5.1.0' ); 1323 return false; 1324 } 1325 1326 return $check; 1327 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Wed Apr 24 08:20:01 2024 | Cross-referenced by PHPXref |