This article, written to accord with WordPress MU, is now obsolete. Please take caution when following its contents, as many things may have changed.

The following functions are additional or modified for WPMU and constitute its API:

Many of the problems we face are because the software lacks good documentation. Please help by creating a page for each of these functions and tagging them with the categories WPMU and WPMU Functions.

When creating new pages you may find this template function useful WPMU_Functions/template as a starting point for your documentation.

• function add_blog_option ( $id, $key, $value )
• function add_site_option ( $key, $value )
• function add_user_to_blog ( $blog_id, $user_id, $role )
• function create_empty_blog ( $domain, $path, $weblog_title, $site_id = 1 )
• function delete_blog_option ( $id, $key )
• function domain_exists ( $domain, $path, $site_id = 1 )
• function generate_random_password ( void )
• function get_active_blog_for_user ( $user_id ) { // get an active blog for user - either primary blog or from blogs list
• function get_admin_users_for_domain ( $sitedomain = [blank string], $path = [blank string] )
• function get_blog_count ( $id = 0 )
• function get_blog_details ( $id, $all = true )
• function get_blog_list ( $start = 0, $num = 10 )
• function get_blog_option ( $blog_id, $setting, $default = 'na' )
• function get_blog_permalink ( $blog_id, $post_id )
• function get_blog_post ( $blog_id, $post_id )
• function get_blog_status ( $id, $pref )
• function get_blogaddress_by_domain ( $domain, $path )
• function get_blogaddress_by_id ( $blog_id )
• function get_blogaddress_by_name ( $blogname )
• function get_bloginfo ( $blogparam )
• function get_blogs_of_user ( $id, $all = false )
• function get_current_site ( void )
• function get_current_user_id ( void )
• function get_last_updated ( $deprecated = [blank string], $start = 0, $quantity = 40 )
• function get_most_active_blogs ( $num = 10, $display = true )
• function get_site_option ( $key, $default = false, $use_cache = true )
• function get_sitestats ( void )
• function get_user_details ( $username )
• function get_user_id_from_string ( $string )
• function insert_blog ( $domain, $path, $site_id )
• function install_blog ( $blog_id, $blog_title = [blank string] )
• function install_blog_defaults ( $blog_id, $user_id )
• function is_archived ( $id )
• function is_blog_user ( $blog_id = 0 )
• function is_email_address_unsafe ( $user_email )
• function is_site_admin ( $user_login = false )
• function is_user_member_of_blog ( $user_id, $blog_id = 0 )
• function load_muplugin_textdomain ( $domain, $path = false )
• function refresh_blog_details ( $id )
• function remove_user_from_blog ( $user_id, $blog_id = [blank string] )
• function restore_current_blog ( void )
• function switch_to_blog ( $new_blog )
• function update_archived ( $id, $archived )
• function update_blog_option ( $id, $key, $value, $refresh = true )
• function update_blog_status ( $id, $pref, $value, $refresh = 1 )
• function update_site_option ( $key, $value )
• function validate_email ( $email, $check_domain = true )
• function wpmu_activate_signup ( $key )
• function wpmu_admin_do_redirect ( $url = [blank string] )
• function wpmu_admin_redirect_add_updated_param ( $url = [blank string] )
• function wpmu_admin_redirect_url ( void )
• function wpmu_checkAvailableSpace ( $action )
• function wpmu_create_blog ( $domain, $path, $title, $user_id, $meta = [blank string], $site_id = 1 )
• function wpmu_create_user ( $user_name, $password, $email )
• function wpmu_signup_blog ( $domain, $path, $title, $user, $user_email, $meta = [blank string] )
• function wpmu_signup_blog_notification ( $domain, $path, $title, $user, $user_email, $key, $meta = [blank string] )
• function wpmu_signup_user ( $user, $user_email, $meta = [blank string] )
• function wpmu_signup_user_notification ( $user, $user_email, $key, $meta = [blank string] )
• function wpmu_update_blogs_date ( void )
• function wpmu_validate_blog_signup ( $blog_id, $blog_title, $user = [blank string] )
• function wpmu_validate_user_signup ( $user_name, $user_email )
• function wpmu_welcome_notification ( $blog_id, $user_id, $password, $title, $meta = [blank string] )
• function wpmu_welcome_user_notification ( $user_id, $password, $meta = [blank string] )