3 * Multi-site WordPress API
6 * @subpackage Multisite
11 * Gets the network's site and user counts.
14 * @uses get_blog_count()
15 * @uses get_user_count()
17 * @return array Site and user count for the network.
19 function get_sitestats() {
22 $stats['blogs'] = get_blog_count();
23 $stats['users'] = get_user_count();
29 * Get the admin for a domain/path combination.
33 * @param string $sitedomain Optional. Site domain.
34 * @param string $path Optional. Site path.
35 * @return array The network admins
37 function get_admin_users_for_domain( $sitedomain = '', $path = '' ) {
41 $site_id = $wpdb->siteid;
43 $site_id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM $wpdb->site WHERE domain = %s AND path = %s", $sitedomain, $path ) );
46 return $wpdb->get_results( $wpdb->prepare( "SELECT u.ID, u.user_login, u.user_pass FROM $wpdb->users AS u, $wpdb->sitemeta AS sm WHERE sm.meta_key = 'admin_user_id' AND u.ID = sm.meta_value AND sm.site_id = %d", $site_id ), ARRAY_A );
52 * Get one of a user's active blogs
54 * Returns the user's primary blog, if she has one and
55 * it is active. If it's inactive, function returns another
56 * active blog of the user. If none are found, the user
57 * is added as a Subscriber to the Dashboard Blog and that blog
61 * @uses get_blogs_of_user()
62 * @uses add_user_to_blog()
63 * @uses get_blog_details()
65 * @param int $user_id The unique ID of the user
66 * @return object The blog object
68 function get_active_blog_for_user( $user_id ) {
70 $blogs = get_blogs_of_user( $user_id );
71 if ( empty( $blogs ) )
74 if ( !is_multisite() )
75 return $blogs[$wpdb->blogid];
77 $primary_blog = get_user_meta( $user_id, 'primary_blog', true );
78 $first_blog = current($blogs);
79 if ( false !== $primary_blog ) {
80 if ( ! isset( $blogs[ $primary_blog ] ) ) {
81 update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
82 $primary = $first_blog;
84 $primary = get_blog_details( $primary_blog );
87 //TODO Review this call to add_user_to_blog too - to get here the user must have a role on this blog?
88 add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
89 update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
90 $primary = $first_blog;
93 if ( ( ! is_object( $primary ) ) || ( is_object( $primary ) && $primary->archived == 1 || $primary->spam == 1 || $primary->deleted == 1 ) ) {
94 $blogs = get_blogs_of_user( $user_id, true ); // if a user's primary blog is shut down, check their other blogs.
96 if ( is_array( $blogs ) && count( $blogs ) > 0 ) {
97 foreach ( (array) $blogs as $blog_id => $blog ) {
98 if ( $blog->site_id != $wpdb->siteid )
100 $details = get_blog_details( $blog_id );
101 if ( is_object( $details ) && $details->archived == 0 && $details->spam == 0 && $details->deleted == 0 ) {
103 if ( get_user_meta( $user_id , 'primary_blog', true ) != $blog_id )
104 update_user_meta( $user_id, 'primary_blog', $blog_id );
105 if ( !get_user_meta($user_id , 'source_domain', true) )
106 update_user_meta( $user_id, 'source_domain', $blog->domain );
120 * Find out whether a user is a member of a given blog.
123 * @uses get_blogs_of_user()
125 * @param int $user_id The unique ID of the user
126 * @param int $blog Optional. If no blog_id is provided, current site is used
129 function is_user_member_of_blog( $user_id, $blog_id = 0 ) {
130 $user_id = (int) $user_id;
131 $blog_id = (int) $blog_id;
133 if ( $blog_id == 0 ) {
135 $blog_id = $wpdb->blogid;
138 $blogs = get_blogs_of_user( $user_id );
139 if ( is_array( $blogs ) )
140 return array_key_exists( $blog_id, $blogs );
146 * The number of active users in your installation.
148 * The count is cached and updated twice daily. This is not a live count.
154 function get_user_count() {
155 return get_site_option( 'user_count' );
159 * The number of active sites on your installation.
161 * The count is cached and updated twice daily. This is not a live count.
165 * @param int $id Optional. A site_id.
168 function get_blog_count( $id = 0 ) {
169 return get_site_option( 'blog_count' );
173 * Get a blog post from any site on the network.
177 * @param int $blog_id ID of the blog.
178 * @param int $post_id ID of the post you're looking for.
179 * @return object The post.
181 function get_blog_post( $blog_id, $post_id ) {
184 $key = $blog_id . '-' . $post_id;
185 $post = wp_cache_get( $key, 'global-posts' );
186 if ( $post == false ) {
187 $post = $wpdb->get_row( $wpdb->prepare( 'SELECT * FROM ' . $wpdb->get_blog_prefix( $blog_id ) . 'posts WHERE ID = %d', $post_id ) );
188 wp_cache_add( $key, $post, 'global-posts' );
195 * Add a user to a blog.
197 * Use the 'add_user_to_blog' action to fire an event when
198 * users are added to a blog.
202 * @param int $blog_id ID of the blog you're adding the user to.
203 * @param int $user_id ID of the user you're adding.
204 * @param string $role The role you want the user to have
207 function add_user_to_blog( $blog_id, $user_id, $role ) {
208 switch_to_blog($blog_id);
210 $user = new WP_User($user_id);
212 if ( empty( $user->ID ) ) {
213 restore_current_blog();
214 return new WP_Error('user_does_not_exist', __('That user does not exist.'));
217 if ( !get_user_meta($user_id, 'primary_blog', true) ) {
218 update_user_meta($user_id, 'primary_blog', $blog_id);
219 $details = get_blog_details($blog_id);
220 update_user_meta($user_id, 'source_domain', $details->domain);
223 $user->set_role($role);
225 do_action('add_user_to_blog', $user_id, $role, $blog_id);
226 wp_cache_delete( $user_id, 'users' );
227 restore_current_blog();
232 * Remove a user from a blog.
234 * Use the 'remove_user_from_blog' action to fire an event when
235 * users are removed from a blog.
237 * Accepts an optional $reassign parameter, if you want to
238 * reassign the user's blog posts to another user upon removal.
242 * @param int $user_id ID of the user you're removing.
243 * @param int $blog_id ID of the blog you're removing the user from.
244 * @param string $reassign Optional. A user to whom to reassign posts.
247 function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') {
249 switch_to_blog($blog_id);
250 $user_id = (int) $user_id;
251 do_action('remove_user_from_blog', $user_id, $blog_id);
253 // If being removed from the primary blog, set a new primary if the user is assigned
254 // to multiple blogs.
255 $primary_blog = get_user_meta($user_id, 'primary_blog', true);
256 if ( $primary_blog == $blog_id ) {
259 $blogs = get_blogs_of_user($user_id);
260 foreach ( (array) $blogs as $blog ) {
261 if ( $blog->userblog_id == $blog_id )
263 $new_id = $blog->userblog_id;
264 $new_domain = $blog->domain;
268 update_user_meta($user_id, 'primary_blog', $new_id);
269 update_user_meta($user_id, 'source_domain', $new_domain);
272 // wp_revoke_user($user_id);
273 $user = new WP_User($user_id);
274 if ( empty( $user->ID ) ) {
275 restore_current_blog();
276 return new WP_Error('user_does_not_exist', __('That user does not exist.'));
279 $user->remove_all_caps();
281 $blogs = get_blogs_of_user($user_id);
282 if ( count($blogs) == 0 ) {
283 update_user_meta($user_id, 'primary_blog', '');
284 update_user_meta($user_id, 'source_domain', '');
287 if ( $reassign != '' ) {
288 $reassign = (int) $reassign;
289 $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET post_author = %d WHERE post_author = %d", $reassign, $user_id) );
290 $wpdb->query( $wpdb->prepare("UPDATE $wpdb->links SET link_owner = %d WHERE link_owner = %d", $reassign, $user_id) );
293 restore_current_blog();
297 * Create an empty blog.
300 * @uses install_blog()
302 * @param string $domain The new blog's domain.
303 * @param string $path The new blog's path.
304 * @param string $string The new blog's title.
305 * @param int $site Optional. Defaults to 1.
306 * @return int The ID of the newly created blog
308 function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) {
309 $domain = addslashes( $domain );
310 $weblog_title = addslashes( $weblog_title );
315 // Check if the domain has been used already. We should return an error message.
316 if ( domain_exists($domain, $path, $site_id) )
317 return __( 'Error: Site URL already taken.' );
319 // Need to back up wpdb table names, and create a new wp_blogs entry for new blog.
320 // Need to get blog_id from wp_blogs, and create new table names.
321 // Must restore table names at the end of function.
323 if ( ! $blog_id = insert_blog($domain, $path, $site_id) )
324 return __( 'Error: problem creating site entry.' );
326 switch_to_blog($blog_id);
327 install_blog($blog_id);
328 restore_current_blog();
334 * Get the permalink for a post on another blog.
338 * @param int $_blog_id ID of the source blog.
339 * @param int $post_id ID of the desired post.
340 * @return string The post's permalink
342 function get_blog_permalink( $_blog_id, $post_id ) {
343 $key = "{$_blog_id}-{$post_id}-blog_permalink";
344 $link = wp_cache_get( $key, 'site-options' );
345 if ( $link == false ) {
346 switch_to_blog( $_blog_id );
347 $link = get_permalink( $post_id );
348 restore_current_blog();
349 wp_cache_add( $key, $link, 'site-options', 360 );
355 * Get a blog's numeric ID from its URL.
357 * On a subdirectory installation like example.com/blog1/,
358 * $domain will be the root 'example.com' and $path the
359 * subdirectory '/blog1/'. With subdomains like blog1.example.com,
360 * $domain is 'blog1.example.com' and $path is '/'.
364 * @param string $domain
365 * @param string $path Optional. Not required for subdomain installations.
368 function get_blog_id_from_url( $domain, $path = '/' ) {
371 $domain = strtolower( $wpdb->escape( $domain ) );
372 $path = strtolower( $wpdb->escape( $path ) );
373 $id = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' );
375 if ( $id == -1 ) { // blog does not exist
381 $id = $wpdb->get_var( "SELECT blog_id FROM $wpdb->blogs WHERE domain = '$domain' and path = '$path' /* get_blog_id_from_url */" );
384 wp_cache_set( md5( $domain . $path ), -1, 'blog-id-cache' );
387 wp_cache_set( md5( $domain . $path ), $id, 'blog-id-cache' );
395 * Redirect a user based on $_GET or $_POST arguments.
397 * The function looks for redirect arguments in the following order:
400 * 3) $_SERVER['HTTP_REFERER']
401 * 4) $_GET['redirect']
402 * 5) $_POST['redirect']
406 * @uses wpmu_admin_redirect_add_updated_param()
410 function wpmu_admin_do_redirect( $url = '' ) {
412 if ( isset( $_GET['ref'] ) )
414 if ( isset( $_POST['ref'] ) )
415 $ref = $_POST['ref'];
418 $ref = wpmu_admin_redirect_add_updated_param( $ref );
422 if ( empty( $_SERVER['HTTP_REFERER'] ) == false ) {
423 wp_redirect( $_SERVER['HTTP_REFERER'] );
427 $url = wpmu_admin_redirect_add_updated_param( $url );
428 if ( isset( $_GET['redirect'] ) ) {
429 if ( substr( $_GET['redirect'], 0, 2 ) == 's_' )
430 $url .= '&action=blogs&s='. esc_html( substr( $_GET['redirect'], 2 ) );
431 } elseif ( isset( $_POST['redirect'] ) ) {
432 $url = wpmu_admin_redirect_add_updated_param( $_POST['redirect'] );
439 * Adds an 'updated=true' argument to a URL.
446 function wpmu_admin_redirect_add_updated_param( $url = '' ) {
447 if ( strpos( $url, 'updated=true' ) === false ) {
448 if ( strpos( $url, '?' ) === false )
449 return $url . '?updated=true';
451 return $url . '&updated=true';
457 * Checks an email address against a list of banned domains.
459 * This function checks against the Banned Email Domains list
460 * at wp-admin/network/settings.php. The check is only run on
461 * self-registrations; user creation at wp-admin/network/users.php
462 * bypasses this check.
466 * @param string $user_email The email provided by the user at registration.
467 * @return bool Returns true when the email address is banned.
469 function is_email_address_unsafe( $user_email ) {
470 $banned_names = get_site_option( 'banned_email_domains' );
471 if ($banned_names && !is_array( $banned_names ))
472 $banned_names = explode( "\n", $banned_names);
474 if ( is_array( $banned_names ) && empty( $banned_names ) == false ) {
475 $email_domain = strtolower( substr( $user_email, 1 + strpos( $user_email, '@' ) ) );
476 foreach ( (array) $banned_names as $banned_domain ) {
477 if ( $banned_domain == '' )
480 strstr( $email_domain, $banned_domain ) ||
482 strstr( $banned_domain, '/' ) &&
483 preg_match( $banned_domain, $email_domain )
493 * Processes new user registrations.
495 * Checks the data provided by the user during signup. Verifies
496 * the validity and uniqueness of user names and user email addresses,
497 * and checks email addresses against admin-provided domain
498 * whitelists and blacklists.
500 * The hook 'wpmu_validate_user_signup' provides an easy way
501 * to modify the signup process. The value $result, which is passed
502 * to the hook, contains both the user-provided info and the error
503 * messages created by the function. 'wpmu_validate_user_signup' allows
504 * you to process the data in any way you'd like, and unset the
505 * relevant errors if necessary.
508 * @uses is_email_address_unsafe()
509 * @uses username_exists()
510 * @uses email_exists()
512 * @param string $user_name The login name provided by the user.
513 * @param string $user_email The email provided by the user.
514 * @return array Contains username, email, and error messages.
516 function wpmu_validate_user_signup($user_name, $user_email) {
519 $errors = new WP_Error();
521 $orig_username = $user_name;
522 $user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );
524 preg_match( '/[a-z0-9]+/', $user_name, $maybe );
526 if ( $user_name != $orig_username || $user_name != $maybe[0] ) {
527 $errors->add( 'user_name', __( 'Only lowercase letters (a-z) and numbers are allowed.' ) );
528 $user_name = $orig_username;
531 $user_email = sanitize_email( $user_email );
533 if ( empty( $user_name ) )
534 $errors->add('user_name', __('Please enter a username'));
536 $illegal_names = get_site_option( 'illegal_names' );
537 if ( is_array( $illegal_names ) == false ) {
538 $illegal_names = array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' );
539 add_site_option( 'illegal_names', $illegal_names );
541 if ( in_array( $user_name, $illegal_names ) == true )
542 $errors->add('user_name', __('That username is not allowed'));
544 if ( is_email_address_unsafe( $user_email ) )
545 $errors->add('user_email', __('You cannot use that email address to signup. We are having problems with them blocking some of our email. Please use another email provider.'));
547 if ( strlen( $user_name ) < 4 )
548 $errors->add('user_name', __('Username must be at least 4 characters'));
550 if ( strpos( ' ' . $user_name, '_' ) != false )
551 $errors->add( 'user_name', __( 'Sorry, usernames may not contain the character “_”!' ) );
555 preg_match( '/[0-9]*/', $user_name, $match );
556 if ( $match[0] == $user_name )
557 $errors->add('user_name', __('Sorry, usernames must have letters too!'));
559 if ( !is_email( $user_email ) )
560 $errors->add('user_email', __('Please enter a correct email address'));
562 $limited_email_domains = get_site_option( 'limited_email_domains' );
563 if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
564 $emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
565 if ( in_array( $emaildomain, $limited_email_domains ) == false )
566 $errors->add('user_email', __('Sorry, that email address is not allowed!'));
569 // Check if the username has been used already.
570 if ( username_exists($user_name) )
571 $errors->add('user_name', __('Sorry, that username already exists!'));
573 // Check if the email address has been used already.
574 if ( email_exists($user_email) )
575 $errors->add('user_email', __('Sorry, that email address is already used!'));
577 // Has someone already signed up for this username?
578 $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE user_login = %s", $user_name) );
579 if ( $signup != null ) {
580 $registered_at = mysql2date('U', $signup->registered);
581 $now = current_time( 'timestamp', true );
582 $diff = $now - $registered_at;
583 // If registered more than two days ago, cancel registration and let this signup go through.
584 if ( $diff > 172800 )
585 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE user_login = %s", $user_name) );
587 $errors->add('user_name', __('That username is currently reserved but may be available in a couple of days.'));
589 if ( $signup->active == 0 && $signup->user_email == $user_email )
590 $errors->add('user_email_used', __('username and email used'));
593 $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE user_email = %s", $user_email) );
594 if ( $signup != null ) {
595 $diff = current_time( 'timestamp', true ) - mysql2date('U', $signup->registered);
596 // If registered more than two days ago, cancel registration and let this signup go through.
597 if ( $diff > 172800 )
598 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE user_email = %s", $user_email) );
600 $errors->add('user_email', __('That email address has already been used. Please check your inbox for an activation email. It will become available in a couple of days if you do nothing.'));
603 $result = array('user_name' => $user_name, 'orig_username' => $orig_username, 'user_email' => $user_email, 'errors' => $errors);
605 return apply_filters('wpmu_validate_user_signup', $result);
609 * Processes new site registrations.
611 * Checks the data provided by the user during blog signup. Verifies
612 * the validity and uniqueness of blog paths and domains.
614 * This function prevents the current user from registering a new site
615 * with a blogname equivalent to another user's login name. Passing the
616 * $user parameter to the function, where $user is the other user, is
617 * effectively an override of this limitation.
619 * Filter 'wpmu_validate_blog_signup' if you want to modify
620 * the way that WordPress validates new site signups.
623 * @uses domain_exists()
624 * @uses username_exists()
626 * @param string $blogname The blog name provided by the user. Must be unique.
627 * @param string $blog_title The blog title provided by the user.
628 * @return array Contains the new site data and error messages.
630 function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') {
631 global $wpdb, $domain, $base, $current_site;
633 $blog_title = strip_tags( $blog_title );
634 $blog_title = substr( $blog_title, 0, 50 );
636 $errors = new WP_Error();
637 $illegal_names = get_site_option( 'illegal_names' );
638 if ( $illegal_names == false ) {
639 $illegal_names = array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' );
640 add_site_option( 'illegal_names', $illegal_names );
643 // On sub dir installs, Some names are so illegal, only a filter can spring them from jail
644 if (! is_subdomain_install() )
645 $illegal_names = array_merge($illegal_names, apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) ) );
648 if ( empty( $blogname ) )
649 $errors->add('blogname', __('Please enter a site name'));
652 preg_match( '/[a-z0-9]+/', $blogname, $maybe );
653 if ( $blogname != $maybe[0] )
654 $errors->add('blogname', __('Only lowercase letters and numbers allowed'));
656 if ( in_array( $blogname, $illegal_names ) == true )
657 $errors->add('blogname', __('That name is not allowed'));
659 if ( strlen( $blogname ) < 4 && !is_super_admin() )
660 $errors->add('blogname', __('Site name must be at least 4 characters'));
662 if ( strpos( ' ' . $blogname, '_' ) != false )
663 $errors->add( 'blogname', __( 'Sorry, site names may not contain the character “_”!' ) );
665 // do not allow users to create a blog that conflicts with a page on the main blog.
666 if ( !is_subdomain_install() && $wpdb->get_var( $wpdb->prepare( "SELECT post_name FROM " . $wpdb->get_blog_prefix( $current_site->blog_id ) . "posts WHERE post_type = 'page' AND post_name = %s", $blogname ) ) )
667 $errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) );
671 preg_match( '/[0-9]*/', $blogname, $match );
672 if ( $match[0] == $blogname )
673 $errors->add('blogname', __('Sorry, site names must have letters too!'));
675 $blogname = apply_filters( 'newblogname', $blogname );
677 $blog_title = stripslashes( $blog_title );
679 if ( empty( $blog_title ) )
680 $errors->add('blog_title', __('Please enter a site title'));
682 // Check if the domain/path has been used already.
683 if ( is_subdomain_install() ) {
684 $mydomain = $blogname . '.' . preg_replace( '|^www\.|', '', $domain );
687 $mydomain = "$domain";
688 $path = $base.$blogname.'/';
690 if ( domain_exists($mydomain, $path) )
691 $errors->add('blogname', __('Sorry, that site already exists!'));
693 if ( username_exists( $blogname ) ) {
694 if ( is_object( $user ) == false || ( is_object($user) && ( $user->user_login != $blogname ) ) )
695 $errors->add( 'blogname', __( 'Sorry, that site is reserved!' ) );
698 // Has someone already signed up for this domain?
699 $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path) ); // TODO: Check email too?
700 if ( ! empty($signup) ) {
701 $diff = current_time( 'timestamp', true ) - mysql2date('U', $signup->registered);
702 // If registered more than two days ago, cancel registration and let this signup go through.
703 if ( $diff > 172800 )
704 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path) );
706 $errors->add('blogname', __('That site is currently reserved but may be available in a couple days.'));
709 $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'errors' => $errors);
710 return apply_filters('wpmu_validate_blog_signup', $result);
714 * Record site signup information for future activation.
717 * @uses wpmu_signup_blog_notification()
719 * @param string $domain The requested domain.
720 * @param string $path The requested path.
721 * @param string $title The requested site title.
722 * @param string $user The user's requested login name.
723 * @param string $user_email The user's email address.
724 * @param array $meta By default, contains the requested privacy setting and lang_id.
726 function wpmu_signup_blog($domain, $path, $title, $user, $user_email, $meta = '') {
729 $key = substr( md5( time() . rand() . $domain ), 0, 16 );
730 $meta = serialize($meta);
731 $domain = $wpdb->escape($domain);
732 $path = $wpdb->escape($path);
733 $title = $wpdb->escape($title);
735 $wpdb->insert( $wpdb->signups, array(
739 'user_login' => $user,
740 'user_email' => $user_email,
741 'registered' => current_time('mysql', true),
742 'activation_key' => $key,
746 wpmu_signup_blog_notification($domain, $path, $title, $user, $user_email, $key, $meta);
750 * Record user signup information for future activation.
752 * This function is used when user registration is open but
753 * new site registration is not.
756 * @uses wpmu_signup_user_notification()
758 * @param string $user The user's requested login name.
759 * @param string $user_email The user's email address.
760 * @param array $meta By default, this is an empty array.
762 function wpmu_signup_user($user, $user_email, $meta = '') {
766 $user = preg_replace( '/\s+/', '', sanitize_user( $user, true ) );
767 $user_email = sanitize_email( $user_email );
768 $key = substr( md5( time() . rand() . $user_email ), 0, 16 );
769 $meta = serialize($meta);
771 $wpdb->insert( $wpdb->signups, array(
775 'user_login' => $user,
776 'user_email' => $user_email,
777 'registered' => current_time('mysql', true),
778 'activation_key' => $key,
782 wpmu_signup_user_notification($user, $user_email, $key, $meta);
786 * Notify user of signup success.
788 * This is the notification function used when site registration
791 * Filter 'wpmu_signup_blog_notification' to bypass this function or
792 * replace it with your own notification behavior.
794 * Filter 'wpmu_signup_blog_notification_email' and
795 * 'wpmu_signup_blog_notification_email' to change the content
796 * and subject line of the email sent to newly registered users.
800 * @param string $domain The new blog domain.
801 * @param string $path The new blog path.
802 * @param string $title The site title.
803 * @param string $user The user's login name.
804 * @param string $user_email The user's email address.
805 * @param array $meta By default, contains the requested privacy setting and lang_id.
806 * @param string $key The activation key created in wpmu_signup_blog()
809 function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_email, $key, $meta = '') {
810 global $current_site;
812 if ( !apply_filters('wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta) )
815 // Send email with activation link.
816 if ( !is_subdomain_install() || $current_site->id != 1 )
817 $activate_url = network_site_url("wp-activate.php?key=$key");
819 $activate_url = "http://{$domain}{$path}wp-activate.php?key=$key"; // @todo use *_url() API
821 $activate_url = esc_url($activate_url);
822 $admin_email = get_site_option( 'admin_email' );
823 if ( $admin_email == '' )
824 $admin_email = 'support@' . $_SERVER['SERVER_NAME'];
825 $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
826 $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
828 apply_filters( 'wpmu_signup_blog_notification_email',
829 __( "To activate your blog, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%s" ),
830 $domain, $path, $title, $user, $user_email, $key, $meta
833 esc_url( "http://{$domain}{$path}" ),
836 // TODO: Don't hard code activation link.
838 apply_filters( 'wpmu_signup_blog_notification_subject',
839 __( '[%1$s] Activate %2$s' ),
840 $domain, $path, $title, $user, $user_email, $key, $meta
843 esc_url( 'http://' . $domain . $path )
845 wp_mail($user_email, $subject, $message, $message_headers);
850 * Notify user of signup success.
852 * This is the notification function used when no new site has
855 * Filter 'wpmu_signup_user_notification' to bypass this function or
856 * replace it with your own notification behavior.
858 * Filter 'wpmu_signup_user_notification_email' and
859 * 'wpmu_signup_user_notification_subject' to change the content
860 * and subject line of the email sent to newly registered users.
864 * @param string $user The user's login name.
865 * @param string $user_email The user's email address.
866 * @param array $meta By default, an empty array.
867 * @param string $key The activation key created in wpmu_signup_user()
870 function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') {
871 if ( !apply_filters('wpmu_signup_user_notification', $user, $user_email, $key, $meta) )
874 // Send email with activation link.
875 $admin_email = get_site_option( 'admin_email' );
876 if ( $admin_email == '' )
877 $admin_email = 'support@' . $_SERVER['SERVER_NAME'];
878 $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
879 $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
881 apply_filters( 'wpmu_signup_user_notification_email',
882 __( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\n" ),
883 $user, $user_email, $key, $meta
885 site_url( "wp-activate.php?key=$key" ),
888 // TODO: Don't hard code activation link.
890 apply_filters( 'wpmu_signup_user_notification_subject',
891 __( '[%1$s] Activate %2$s' ),
892 $user, $user_email, $key, $meta
897 wp_mail($user_email, $subject, $message, $message_headers);
904 * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events
905 * that should happen only when users or sites are self-created (since
906 * those actions are not called when users and sites are created
910 * @uses wp_generate_password()
911 * @uses wpmu_welcome_user_notification()
912 * @uses add_user_to_blog()
913 * @uses add_new_user_to_blog()
914 * @uses wpmu_create_user()
915 * @uses wpmu_create_blog()
916 * @uses wpmu_welcome_notification()
918 * @param string $key The activation key provided to the user.
919 * @return array An array containing information about the activated user and/or blog
921 function wpmu_activate_signup($key) {
922 global $wpdb, $current_site;
924 $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key) );
926 if ( empty( $signup ) )
927 return new WP_Error( 'invalid_key', __( 'Invalid activation key.' ) );
929 if ( $signup->active ) {
930 if ( empty( $signup->domain ) )
931 return new WP_Error( 'already_active', __( 'The user is already active.' ), $signup );
933 return new WP_Error( 'already_active', __( 'The site is already active.' ), $signup );
936 $meta = unserialize($signup->meta);
937 $user_login = $wpdb->escape($signup->user_login);
938 $user_email = $wpdb->escape($signup->user_email);
939 $password = wp_generate_password( 12, false );
941 $user_id = username_exists($user_login);
944 $user_id = wpmu_create_user($user_login, $password, $user_email);
946 $user_already_exists = true;
949 return new WP_Error('create_user', __('Could not create user'), $signup);
951 $now = current_time('mysql', true);
953 if ( empty($signup->domain) ) {
954 $wpdb->update( $wpdb->signups, array('active' => 1, 'activated' => $now), array('activation_key' => $key) );
956 if ( isset( $user_already_exists ) )
957 return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup);
959 wpmu_welcome_user_notification($user_id, $password, $meta);
961 add_new_user_to_blog( $user_id, $user_email, $meta );
962 do_action('wpmu_activate_user', $user_id, $password, $meta);
963 return array('user_id' => $user_id, 'password' => $password, 'meta' => $meta);
966 $blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, $wpdb->siteid );
968 // TODO: What to do if we create a user but cannot create a blog?
969 if ( is_wp_error($blog_id) ) {
970 // If blog is taken, that means a previous attempt to activate this blog failed in between creating the blog and
971 // setting the activation flag. Let's just set the active flag and instruct the user to reset their password.
972 if ( 'blog_taken' == $blog_id->get_error_code() ) {
973 $blog_id->add_data( $signup );
974 $wpdb->update( $wpdb->signups, array( 'active' => 1, 'activated' => $now ), array( 'activation_key' => $key ) );
979 $wpdb->update( $wpdb->signups, array('active' => 1, 'activated' => $now), array('activation_key' => $key) );
980 wpmu_welcome_notification($blog_id, $user_id, $password, $signup->title, $meta);
981 do_action('wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta);
983 return array('blog_id' => $blog_id, 'user_id' => $user_id, 'password' => $password, 'title' => $signup->title, 'meta' => $meta);
989 * This function runs when a user self-registers as well as when
990 * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events
991 * that should affect all new users, but only on Multisite (otherwise
992 * use 'user_register').
995 * @uses wp_create_user()
997 * @param string $user_name The new user's login name.
998 * @param string $password The new user's password.
999 * @param string $email The new user's email address.
1000 * @return mixed Returns false on failure, or int $user_id on success
1002 function wpmu_create_user( $user_name, $password, $email) {
1003 $user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );
1005 $user_id = wp_create_user( $user_name, $password, $email );
1006 if ( is_wp_error($user_id) )
1009 // Newly created users have no roles or caps until they are added to a blog.
1010 delete_user_option( $user_id, 'capabilities' );
1011 delete_user_option( $user_id, 'user_level' );
1013 do_action( 'wpmu_new_user', $user_id );
1021 * This function runs when a user self-registers a new site as well
1022 * as when a Super Admin creates a new site. Hook to 'wpmu_new_blog'
1023 * for events that should affect all new sites.
1025 * On subdirectory installs, $domain is the same as the main site's
1026 * domain, and the path is the subdirectory name (eg 'example.com'
1027 * and '/blog1/'). On subdomain installs, $domain is the new subdomain +
1028 * root domain (eg 'blog1.example.com'), and $path is '/'.
1031 * @uses domain_exists()
1032 * @uses insert_blog()
1033 * @uses wp_install_defaults()
1034 * @uses add_user_to_blog()
1036 * @param string $domain The new site's domain.
1037 * @param string $path The new site's path.
1038 * @param string $title The new site's title.
1039 * @param int $user_id The user ID of the new site's admin.
1040 * @param array $meta Optional. Used to set initial site options.
1041 * @param int $site_id Optional. Only relevant on multi-network installs.
1042 * @return mixed Returns WP_Error object on failure, int $blog_id on success
1044 function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id = 1) {
1045 $domain = preg_replace( '/\s+/', '', sanitize_user( $domain, true ) );
1047 if ( is_subdomain_install() )
1048 $domain = str_replace( '@', '', $domain );
1050 $title = strip_tags( $title );
1051 $user_id = (int) $user_id;
1056 // Check if the domain has been used already. We should return an error message.
1057 if ( domain_exists($domain, $path, $site_id) )
1058 return new WP_Error('blog_taken', __('Site already exists.'));
1060 if ( !defined('WP_INSTALLING') )
1061 define( 'WP_INSTALLING', true );
1063 if ( ! $blog_id = insert_blog($domain, $path, $site_id) )
1064 return new WP_Error('insert_blog', __('Could not create site.'));
1066 switch_to_blog($blog_id);
1067 install_blog($blog_id, $title);
1068 wp_install_defaults($user_id);
1070 add_user_to_blog($blog_id, $user_id, 'administrator');
1072 if ( is_array($meta) ) foreach ($meta as $key => $value) {
1073 if ( $key == 'public' || $key == 'archived' || $key == 'mature' || $key == 'spam' || $key == 'deleted' || $key == 'lang_id' )
1074 update_blog_status( $blog_id, $key, $value );
1076 update_option( $key, $value );
1079 add_option( 'WPLANG', get_site_option( 'WPLANG' ) );
1080 update_option( 'blog_public', (int)$meta['public'] );
1082 if ( !is_super_admin() && ! get_user_meta( $user_id, 'primary_blog', true ) )
1083 update_user_meta( $user_id, 'primary_blog', $blog_id );
1085 restore_current_blog();
1086 do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $site_id, $meta );
1092 * Notifies the network admin that a new site has been activated.
1094 * Filter 'newblog_notify_siteadmin' to change the content of
1095 * the notification email.
1099 * @param int $blog_id The new site's ID.
1102 function newblog_notify_siteadmin( $blog_id, $deprecated = '' ) {
1103 if ( get_site_option( 'registrationnotification' ) != 'yes' )
1106 $email = get_site_option( 'admin_email' );
1107 if ( is_email($email) == false )
1110 $options_site_url = esc_url(network_admin_url('settings.php'));
1112 switch_to_blog( $blog_id );
1113 $blogname = get_option( 'blogname' );
1114 $siteurl = site_url();
1115 restore_current_blog();
1117 $msg = sprintf( __( 'New Site: %1s
1121 Disable these notifications: %4s' ), $blogname, $siteurl, $_SERVER['REMOTE_ADDR'], $options_site_url);
1122 $msg = apply_filters( 'newblog_notify_siteadmin', $msg );
1124 wp_mail( $email, sprintf( __( 'New Site Registration: %s' ), $siteurl ), $msg );
1129 * Notifies the network admin that a new user has been activated.
1131 * Filter 'newuser_notify_siteadmin' to change the content of
1132 * the notification email.
1136 * @param int $user_id The new user's ID.
1139 function newuser_notify_siteadmin( $user_id ) {
1140 if ( get_site_option( 'registrationnotification' ) != 'yes' )
1143 $email = get_site_option( 'admin_email' );
1145 if ( is_email($email) == false )
1148 $user = new WP_User($user_id);
1150 $options_site_url = esc_url(network_admin_url('settings.php'));
1151 $msg = sprintf(__('New User: %1s
1154 Disable these notifications: %3s'), $user->user_login, $_SERVER['REMOTE_ADDR'], $options_site_url);
1156 $msg = apply_filters( 'newuser_notify_siteadmin', $msg );
1157 wp_mail( $email, sprintf(__('New User Registration: %s'), $user->user_login), $msg );
1162 * Check whether a blogname is already taken.
1164 * Used during the new site registration process to ensure
1165 * that each blogname is unique.
1169 * @param string $domain The domain to be checked.
1170 * @param string $path The path to be checked.
1171 * @param int $site_id Optional. Relevant only on multi-network installs.
1174 function domain_exists($domain, $path, $site_id = 1) {
1176 return $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) );
1180 * Store basic site info in the blogs table.
1182 * This function creates a row in the wp_blogs table and returns
1183 * the new blog's ID. It is the first step in creating a new blog.
1187 * @param string $domain The domain of the new site.
1188 * @param string $path The path of the new site.
1189 * @param int $site_id Unless you're running a multi-network install, be sure to set this value to 1.
1190 * @return int The ID of the new row
1192 function insert_blog($domain, $path, $site_id) {
1195 $path = trailingslashit($path);
1196 $site_id = (int) $site_id;
1198 $result = $wpdb->insert( $wpdb->blogs, array('site_id' => $site_id, 'domain' => $domain, 'path' => $path, 'registered' => current_time('mysql')) );
1202 refresh_blog_details($wpdb->insert_id);
1203 return $wpdb->insert_id;
1207 * Install an empty blog.
1209 * Creates the new blog tables and options. If calling this function
1210 * directly, be sure to use switch_to_blog() first, so that $wpdb
1211 * points to the new blog.
1214 * @uses make_db_current_silent()
1215 * @uses populate_roles()
1217 * @param int $blog_id The value returned by insert_blog().
1218 * @param string $blog_title The title of the new site.
1220 function install_blog($blog_id, $blog_title = '') {
1221 global $wpdb, $table_prefix, $wp_roles;
1222 $wpdb->suppress_errors();
1224 // Cast for security
1225 $blog_id = (int) $blog_id;
1227 require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
1229 if ( $wpdb->get_results("SELECT ID FROM $wpdb->posts") )
1230 die(__('<h1>Already Installed</h1><p>You appear to have already installed WordPress. To reinstall please clear your old database tables first.</p>') . '</body></html>');
1232 $wpdb->suppress_errors(false);
1234 $url = get_blogaddress_by_id($blog_id);
1236 // Set everything up
1237 make_db_current_silent();
1243 update_option('siteurl', $url);
1244 update_option('home', $url);
1245 update_option('fileupload_url', $url . "files" );
1246 update_option('upload_path', UPLOADBLOGSDIR . "/$blog_id/files");
1247 update_option('blogname', stripslashes( $blog_title ) );
1248 update_option('admin_email', '');
1249 $wpdb->update( $wpdb->options, array('option_value' => ''), array('option_name' => 'admin_email') );
1252 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE meta_key = %s", $table_prefix.'user_level') );
1253 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE meta_key = %s", $table_prefix.'capabilities') );
1255 $wpdb->suppress_errors( false );
1259 * Set blog defaults.
1261 * This function creates a row in the wp_blogs table.
1265 * @deprecated Use wp_install_defaults()
1266 * @uses wp_install_defaults()
1268 * @param int $blog_id Ignored in this function.
1269 * @param int $user_id
1271 function install_blog_defaults($blog_id, $user_id) {
1274 require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
1276 $wpdb->suppress_errors();
1278 wp_install_defaults($user_id);
1280 $wpdb->suppress_errors( false );
1284 * Notify a user that her blog activation has been successful.
1286 * Filter 'wpmu_welcome_notification' to disable or bypass.
1288 * Filter 'update_welcome_email' and 'update_welcome_subject' to
1289 * modify the content and subject line of the notification email.
1293 * @param int $blog_id
1294 * @param int $user_id
1295 * @param string $password
1296 * @param string $title The new blog's title
1297 * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
1300 function wpmu_welcome_notification($blog_id, $user_id, $password, $title, $meta = '') {
1301 global $current_site;
1303 if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) )
1306 $welcome_email = stripslashes( get_site_option( 'welcome_email' ) );
1307 if ( $welcome_email == false )
1308 $welcome_email = stripslashes( __( 'Dear User,
1310 Your new SITE_NAME site has been successfully set up at:
1313 You can log in to the administrator account with the following information:
1316 Login Here: BLOG_URLwp-login.php
1318 We hope you enjoy your new site.
1321 --The Team @ SITE_NAME' ) );
1323 $url = get_blogaddress_by_id($blog_id);
1324 $user = new WP_User($user_id);
1326 $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email );
1327 $welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email );
1328 $welcome_email = str_replace( 'BLOG_URL', $url, $welcome_email );
1329 $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
1330 $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
1332 $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta);
1333 $admin_email = get_site_option( 'admin_email' );
1335 if ( $admin_email == '' )
1336 $admin_email = 'support@' . $_SERVER['SERVER_NAME'];
1338 $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
1339 $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1340 $message = $welcome_email;
1342 if ( empty( $current_site->site_name ) )
1343 $current_site->site_name = 'WordPress MU';
1345 $subject = apply_filters( 'update_welcome_subject', sprintf(__('New %1$s Site: %2$s'), $current_site->site_name, stripslashes( $title ) ) );
1346 wp_mail($user->user_email, $subject, $message, $message_headers);
1351 * Notify a user that her account activation has been successful.
1353 * Filter 'wpmu_welcome_user_notification' to disable or bypass.
1355 * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to
1356 * modify the content and subject line of the notification email.
1360 * @param int $user_id
1361 * @param string $password
1362 * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
1365 function wpmu_welcome_user_notification($user_id, $password, $meta = '') {
1366 global $current_site;
1368 if ( !apply_filters('wpmu_welcome_user_notification', $user_id, $password, $meta) )
1371 $welcome_email = get_site_option( 'welcome_user_email' );
1373 $user = new WP_User($user_id);
1375 $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta);
1376 $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email );
1377 $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
1378 $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
1379 $welcome_email = str_replace( 'LOGINLINK', wp_login_url(), $welcome_email );
1381 $admin_email = get_site_option( 'admin_email' );
1383 if ( $admin_email == '' )
1384 $admin_email = 'support@' . $_SERVER['SERVER_NAME'];
1386 $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
1387 $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1388 $message = $welcome_email;
1390 if ( empty( $current_site->site_name ) )
1391 $current_site->site_name = 'WordPress MU';
1393 $subject = apply_filters( 'update_welcome_user_subject', sprintf(__('New %1$s User: %2$s'), $current_site->site_name, $user->user_login) );
1394 wp_mail($user->user_email, $subject, $message, $message_headers);
1399 * Get the current site info.
1401 * Returns an object containing the ID, domain, path, and site_name
1402 * of the site being viewed.
1408 function get_current_site() {
1409 global $current_site;
1410 return $current_site;
1414 * Get a numeric user ID from either an email address or a login.
1419 * @param string $string
1422 function get_user_id_from_string( $string ) {
1424 if ( is_email( $string ) ) {
1425 $user = get_user_by('email', $string);
1427 $user_id = $user->ID;
1428 } elseif ( is_numeric( $string ) ) {
1431 $user = get_user_by('login', $string);
1433 $user_id = $user->ID;
1440 * Get a user's most recent post.
1442 * Walks through each of a user's blogs to find the post with
1443 * the most recent post_date_gmt.
1446 * @uses get_blogs_of_user()
1448 * @param int $user_id
1449 * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
1451 function get_most_recent_post_of_user( $user_id ) {
1454 $user_blogs = get_blogs_of_user( (int) $user_id );
1455 $most_recent_post = array();
1457 // Walk through each blog and get the most recent post
1458 // published by $user_id
1459 foreach ( (array) $user_blogs as $blog ) {
1460 $recent_post = $wpdb->get_row( $wpdb->prepare("SELECT ID, post_date_gmt FROM {$wpdb->base_prefix}{$blog->userblog_id}_posts WHERE post_author = %d AND post_type = 'post' AND post_status = 'publish' ORDER BY post_date_gmt DESC LIMIT 1", $user_id ), ARRAY_A);
1462 // Make sure we found a post
1463 if ( isset($recent_post['ID']) ) {
1464 $post_gmt_ts = strtotime($recent_post['post_date_gmt']);
1466 // If this is the first post checked or if this post is
1467 // newer than the current recent post, make it the new
1468 // most recent post.
1469 if ( !isset($most_recent_post['post_gmt_ts']) || ( $post_gmt_ts > $most_recent_post['post_gmt_ts'] ) ) {
1470 $most_recent_post = array(
1471 'blog_id' => $blog->userblog_id,
1472 'post_id' => $recent_post['ID'],
1473 'post_date_gmt' => $recent_post['post_date_gmt'],
1474 'post_gmt_ts' => $post_gmt_ts
1480 return $most_recent_post;
1486 * Get the size of a directory.
1488 * A helper function that is used primarily to check whether
1489 * a blog has exceeded its allowed upload space.
1492 * @uses recurse_dirsize()
1494 * @param string $directory
1497 function get_dirsize( $directory ) {
1498 $dirsize = get_transient( 'dirsize_cache' );
1499 if ( is_array( $dirsize ) && isset( $dirsize[ $directory ][ 'size' ] ) )
1500 return $dirsize[ $directory ][ 'size' ];
1502 if ( false == is_array( $dirsize ) )
1505 $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
1507 set_transient( 'dirsize_cache', $dirsize, 3600 );
1508 return $dirsize[ $directory ][ 'size' ];
1512 * Get the size of a directory recursively.
1514 * Used by get_dirsize() to get a directory's size when it contains
1515 * other directories.
1519 * @param string $directory
1522 function recurse_dirsize( $directory ) {
1525 if ( substr( $directory, -1 ) == '/' )
1526 $directory = substr($directory,0,-1);
1528 if ( !file_exists($directory) || !is_dir( $directory ) || !is_readable( $directory ) )
1531 if ($handle = opendir($directory)) {
1532 while(($file = readdir($handle)) !== false) {
1533 $path = $directory.'/'.$file;
1534 if ($file != '.' && $file != '..') {
1535 if (is_file($path)) {
1536 $size += filesize($path);
1537 } elseif (is_dir($path)) {
1538 $handlesize = recurse_dirsize($path);
1539 if ($handlesize > 0)
1540 $size += $handlesize;
1550 * Check whether a blog has used its allotted upload space.
1552 * Used by get_dirsize() to get a directory's size when it contains
1553 * other directories.
1556 * @uses get_dirsize()
1558 * @param bool $echo Optional. If $echo is set and the quota is exceeded, a warning message is echoed. Default is true.
1561 function upload_is_user_over_quota( $echo = true ) {
1562 if ( get_site_option( 'upload_space_check_disabled' ) )
1565 $spaceAllowed = get_space_allowed();
1566 if ( empty( $spaceAllowed ) || !is_numeric( $spaceAllowed ) )
1567 $spaceAllowed = 10; // Default space allowed is 10 MB
1569 $dirName = BLOGUPLOADDIR;
1570 $size = get_dirsize($dirName) / 1024 / 1024;
1572 if ( ($spaceAllowed-$size) < 0 ) {
1574 _e( 'Sorry, you have used your space allocation. Please delete some files to upload more files.' ); // No space left
1582 * Check an array of MIME types against a whitelist.
1584 * WordPress ships with a set of allowed upload filetypes,
1585 * which is defined in wp-includes/functions.php in
1586 * get_allowed_mime_types(). This function is used to filter
1587 * that list against the filetype whitelist provided by Multisite
1588 * Super Admins at wp-admin/network/settings.php.
1592 * @param array $mimes
1595 function check_upload_mimes( $mimes ) {
1596 $site_exts = explode( ' ', get_site_option( 'upload_filetypes' ) );
1597 foreach ( $site_exts as $ext ) {
1598 foreach ( $mimes as $ext_pattern => $mime ) {
1599 if ( $ext != '' && strpos( $ext_pattern, $ext ) !== false )
1600 $site_mimes[$ext_pattern] = $mime;
1607 * Update a blog's post count.
1609 * WordPress MS stores a blog's post count as an option so as
1610 * to avoid extraneous COUNTs when a blog's details are fetched
1611 * with get_blog_details(). This function is called when posts
1612 * are published to make sure the count stays current.
1616 function update_posts_count( $deprecated = '' ) {
1618 update_option( 'post_count', (int) $wpdb->get_var( "SELECT COUNT(ID) FROM {$wpdb->posts} WHERE post_status = 'publish' and post_type = 'post'" ) );
1622 * Logs user registrations.
1626 * @param int $blog_id
1627 * @param int $user_id
1629 function wpmu_log_new_registrations( $blog_id, $user_id ) {
1631 $user = new WP_User( (int) $user_id );
1632 $wpdb->insert( $wpdb->registration_log, array('email' => $user->user_email, 'IP' => preg_replace( '/[^0-9., ]/', '',$_SERVER['REMOTE_ADDR'] ), 'blog_id' => $blog_id, 'date_registered' => current_time('mysql')) );
1636 * Get the remaining upload space for this blog.
1639 * @uses upload_is_user_over_quota()
1640 * @uses get_space_allowed()
1641 * @uses get_dirsize()
1646 function fix_import_form_size( $size ) {
1647 if ( upload_is_user_over_quota( false ) == true )
1650 $spaceAllowed = 1024 * 1024 * get_space_allowed();
1651 $dirName = BLOGUPLOADDIR;
1652 $dirsize = get_dirsize($dirName) ;
1653 if ( $size > $spaceAllowed - $dirsize )
1654 return $spaceAllowed - $dirsize; // remaining space
1656 return $size; // default
1660 * Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.
1664 * @see term_id_filter
1666 * @param int $term_id An ID for a term on the current blog.
1667 * @return int An ID from the global terms table mapped from $term_id.
1669 function global_terms( $term_id, $deprecated = '' ) {
1671 static $global_terms_recurse = null;
1673 if ( !global_terms_enabled() )
1676 // prevent a race condition
1677 $recurse_start = false;
1678 if ( $global_terms_recurse === null ) {
1679 $recurse_start = true;
1680 $global_terms_recurse = 1;
1681 } elseif ( 10 < $global_terms_recurse++ ) {
1685 $term_id = intval( $term_id );
1686 $c = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->terms WHERE term_id = %d", $term_id ) );
1688 $global_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM $wpdb->sitecategories WHERE category_nicename = %s", $c->slug ) );
1689 if ( $global_id == null ) {
1690 $used_global_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM $wpdb->sitecategories WHERE cat_ID = %d", $c->term_id ) );
1691 if ( null == $used_global_id ) {
1692 $wpdb->insert( $wpdb->sitecategories, array( 'cat_ID' => $term_id, 'cat_name' => $c->name, 'category_nicename' => $c->slug ) );
1693 $global_id = $wpdb->insert_id;
1694 if ( empty( $global_id ) )
1697 $max_global_id = $wpdb->get_var( "SELECT MAX(cat_ID) FROM $wpdb->sitecategories" );
1698 $max_local_id = $wpdb->get_var( "SELECT MAX(term_id) FROM $wpdb->terms" );
1699 $new_global_id = max( $max_global_id, $max_local_id ) + mt_rand( 100, 400 );
1700 $wpdb->insert( $wpdb->sitecategories, array( 'cat_ID' => $new_global_id, 'cat_name' => $c->name, 'category_nicename' => $c->slug ) );
1701 $global_id = $wpdb->insert_id;
1703 } elseif ( $global_id != $term_id ) {
1704 $local_id = $wpdb->get_row( $wpdb->prepare( "SELECT term_id FROM $wpdb->terms WHERE term_id = %d", $global_id ) );
1705 if ( null != $local_id )
1706 $local_id = global_terms( $local_id );
1707 if ( 10 < $global_terms_recurse )
1708 $global_id = $term_id;
1711 if ( $global_id != $term_id ) {
1712 if ( get_option( 'default_category' ) == $term_id )
1713 update_option( 'default_category', $global_id );
1715 $wpdb->update( $wpdb->terms, array('term_id' => $global_id), array('term_id' => $term_id) );
1716 $wpdb->update( $wpdb->term_taxonomy, array('term_id' => $global_id), array('term_id' => $term_id) );
1717 $wpdb->update( $wpdb->term_taxonomy, array('parent' => $global_id), array('parent' => $term_id) );
1719 clean_term_cache($term_id);
1721 if( $recurse_start )
1722 $global_terms_recurse = null;
1728 * Ensure that the current site's domain is listed in the allowed redirect host list.
1730 * @see wp_validate_redirect()
1733 * @return array The current site's domain
1735 function redirect_this_site( $deprecated = '' ) {
1736 global $current_site;
1737 return array( $current_site->domain );
1741 * Check whether an upload is too big.
1745 * @param array $upload
1746 * @return mixed If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
1748 function upload_is_file_too_big( $upload ) {
1749 if ( is_array( $upload ) == false || defined( 'WP_IMPORTING' ) )
1752 if ( strlen( $upload['bits'] ) > ( 1024 * get_site_option( 'fileupload_maxk', 1500 ) ) )
1753 return sprintf( __( 'This file is too big. Files must be less than %d KB in size.' ) . '<br />', get_site_option( 'fileupload_maxk', 1500 ));
1759 * Add a nonce field to the signup page.
1762 * @uses wp_nonce_field()
1764 function signup_nonce_fields() {
1766 echo "<input type='hidden' name='signup_form_id' value='{$id}' />";
1767 wp_nonce_field('signup_form_' . $id, '_signup_form', false);
1771 * Process the signup nonce created in signup_nonce_fields().
1774 * @uses wp_create_nonce()
1776 * @param array $result
1779 function signup_nonce_check( $result ) {
1780 if ( !strpos( $_SERVER[ 'PHP_SELF' ], 'wp-signup.php' ) )
1783 if ( wp_create_nonce('signup_form_' . $_POST[ 'signup_form_id' ]) != $_POST['_signup_form'] )
1784 wp_die( __('Please try again!') );
1790 * Correct 404 redirects when NOBLOGREDIRECT is defined.
1794 function maybe_redirect_404() {
1795 global $current_site;
1796 if ( is_main_site() && is_404() && defined( 'NOBLOGREDIRECT' ) && ( $destination = apply_filters( 'blog_redirect_404', NOBLOGREDIRECT ) ) ) {
1797 if ( $destination == '%siteurl%' )
1798 $destination = network_home_url();
1799 wp_redirect( $destination );
1805 * Add a new user to a blog by visiting /newbloguser/username/.
1807 * This will only work when the user's details are saved as an option
1808 * keyed as 'new_user_x', where 'x' is the username of the user to be
1809 * added, as when a user is invited through the regular WP Add User interface.
1812 * @uses add_existing_user_to_blog()
1814 function maybe_add_existing_user_to_blog() {
1815 if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) )
1818 $parts = explode( '/', $_SERVER[ 'REQUEST_URI' ] );
1819 $key = array_pop( $parts );
1822 $key = array_pop( $parts );
1824 $details = get_option( 'new_user_' . $key );
1825 if ( !empty( $details ) )
1826 delete_option( 'new_user_' . $key );
1828 if ( empty( $details ) || is_wp_error( add_existing_user_to_blog( $details ) ) )
1829 wp_die( sprintf(__('An error occurred adding you to this site. Back to the <a href="%s">homepage</a>.'), site_url() ) );
1831 wp_die( sprintf(__('You have been added to this site. Please visit the <a href="%s">homepage</a> or <a href="%s">login</a> using your username and password.'), site_url(), admin_url() ), __('Success') );
1835 * Add a user to a blog based on details from maybe_add_existing_user_to_blog().
1838 * @uses add_user_to_blog()
1840 * @param array $details
1842 function add_existing_user_to_blog( $details = false ) {
1845 if ( is_array( $details ) ) {
1846 $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
1847 do_action( 'added_existing_user', $details[ 'user_id' ], $result );
1853 * Add a newly created user to the appropriate blog
1857 * @param int $user_id
1858 * @param string $email
1859 * @param array $meta
1861 function add_new_user_to_blog( $user_id, $email, $meta ) {
1862 global $current_site;
1863 if ( $meta[ 'add_to_blog' ] ) {
1864 $blog_id = $meta[ 'add_to_blog' ];
1865 $role = $meta[ 'new_role' ];
1866 remove_user_from_blog($user_id, $current_site->blog_id); // remove user from main blog.
1867 add_user_to_blog( $blog_id, $user_id, $role );
1868 update_user_meta( $user_id, 'primary_blog', $blog_id );
1873 * Correct From host on outgoing mail to match the site domain
1877 function fix_phpmailer_messageid( $phpmailer ) {
1878 global $current_site;
1879 $phpmailer->Hostname = $current_site->domain;
1883 * Check to see whether a user is marked as a spammer, based on username
1886 * @uses get_current_user_id()
1887 * @uses get_user_id_from_string()
1889 * @param string $username
1892 function is_user_spammy( $username = 0 ) {
1893 if ( $username == 0 ) {
1894 $user_id = get_current_user_id();
1896 $user_id = get_user_id_from_string( $username );
1898 $u = new WP_User( $user_id );
1900 return ( isset( $u->spam ) && $u->spam == 1 );
1904 * Update this blog's 'public' setting in the global blogs table.
1906 * Public blogs have a setting of 1, private blogs are 0.
1909 * @uses update_blog_status()
1911 * @param int $old_value
1912 * @param int $value The new public value
1915 function update_blog_public( $old_value, $value ) {
1917 do_action('update_blog_public');
1918 update_blog_status( $wpdb->blogid, 'public', (int) $value );
1920 add_action('update_option_blog_public', 'update_blog_public', 10, 2);
1923 * Get the "dashboard blog", the blog where users without a blog edit their profile data.
1926 * @uses get_blog_details()
1930 function get_dashboard_blog() {
1931 if ( $blog = get_site_option( 'dashboard_blog' ) )
1932 return get_blog_details( $blog );
1934 return get_blog_details( $GLOBALS['current_site']->blog_id );
1938 * Check whether a usermeta key has to do with the current blog.
1941 * @uses wp_get_current_user()
1943 * @param string $key
1944 * @param int $user_id Optional. Defaults to current user.
1945 * @param int $blog_id Optional. Defaults to current blog.
1948 function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
1951 $current_user = wp_get_current_user();
1952 if ( $user_id == 0 )
1953 $user_id = $current_user->ID;
1954 if ( $blog_id == 0 )
1955 $blog_id = $wpdb->blogid;
1957 $local_key = $wpdb->base_prefix . $blog_id . '_' . $key;
1959 if ( isset( $current_user->$local_key ) )
1966 * Check whether users can self-register, based on Network settings.
1972 function users_can_register_signup_filter() {
1973 $registration = get_site_option('registration');
1974 if ( $registration == 'all' || $registration == 'user' )
1979 add_filter('option_users_can_register', 'users_can_register_signup_filter');
1982 * Ensure that the welcome message is not empty. Currently unused.
1986 * @param string $text
1989 function welcome_user_msg_filter( $text ) {
1991 return __( 'Dear User,
1993 Your new account is set up.
1995 You can log in with the following information:
2002 --The Team @ SITE_NAME' );
2006 add_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' );
2009 * Whether to force SSL on content.
2013 * @param string|bool $force
2014 * @return bool True if forced, false if not forced.
2016 function force_ssl_content( $force = '' ) {
2017 static $forced_content;
2019 if ( '' != $force ) {
2020 $old_forced = $forced_content;
2021 $forced_content = $force;
2025 return $forced_content;
2029 * Formats an String URL to use HTTPS if HTTP is found.
2030 * Useful as a filter.
2034 function filter_SSL( $url ) {
2035 if ( !is_string( $url ) )
2036 return get_bloginfo( 'url' ); //return home blog url with proper scheme
2038 $arrURL = parse_url( $url );
2040 if ( force_ssl_content() && is_ssl() ) {
2041 if ( 'http' === $arrURL['scheme'] && 'https' !== $arrURL['scheme'] )
2042 $url = str_replace( $arrURL['scheme'], 'https', $url );
2049 * Schedule update of the network-wide counts for the current network.
2053 function wp_schedule_update_network_counts() {
2054 if ( !is_main_site() )
2057 if ( !wp_next_scheduled('update_network_counts') && !defined('WP_INSTALLING') )
2058 wp_schedule_event(time(), 'twicedaily', 'update_network_counts');
2062 * Update the network-wide counts for the current network.
2066 function wp_update_network_counts() {
2069 $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(blog_id) as c FROM $wpdb->blogs WHERE site_id = %d AND spam = '0' AND deleted = '0' and archived = '0'", $wpdb->siteid) );
2070 update_site_option( 'blog_count', $count );
2072 $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(ID) as c FROM $wpdb->users WHERE spam = '0' AND deleted = '0'") );
2073 update_site_option( 'user_count', $count );