wp_install() – Installs the site.

You appear to be a bot. Output may be restricted

Description

Installs the site.

Runs the required functions to set up and populate the database, including primary admin user and initial options.

Usage

$array = wp_install( $blog_title, $user_name, $user_email, $is_public, $deprecated, $user_password, $language );

Parameters

$blog_title
( string ) required – Site title.
$user_name
( string ) required – User's username.
$user_email
( string ) required – User's email.
$is_public
( bool ) required – Whether the site is public.
$deprecated
( string ) optional – Optional. Not used.
$user_password
( string ) optional – Optional. User's chosen password. Default empty (random password).
$language
( string ) optional – Optional. Language chosen. Default empty.
$url
( string ) optional – The URL of the site.
$user_id
( int ) optional – The ID of the site owner.
$password
( string ) optional – The password of the site owner, if their user account didn't already exist.
$password_message
( string ) optional – The explanatory message regarding the password. }

Returns

array { Data for the newly installed site.

Source

File name: wordpress/wp-admin/includes/upgrade.php
Lines:

1 to 90 of 90
  function wp_install( $blog_title, $user_name, $user_email, $is_public, $deprecated = '', $user_password = '', $language = '' ) {
    if ( ! empty( $deprecated ) ) {
      _deprecated_argument( wp_install, '2.6.0' );
    }

    wp_check_mysql_version();
    wp_cache_flush();
    make_db_current_silent();
    populate_options();
    populate_roles();

    update_option( 'blogname', $blog_title );
    update_option( 'admin_email', $user_email );
    update_option( 'blog_public', $is_public );

    // Freshness of site - in the future, this could get more specific about actions taken, perhaps.
    update_option( 'fresh_site', 1 );

    if ( $language ) {
      update_option( 'WPLANG', $language );
    }

    $guessurl = wp_guess_url();

    update_option( 'siteurl', $guessurl );

    // If not a public site, don't ping.
    if ( ! $is_public ) {
      update_option( 'default_pingback_flag', 0 );
    }

    /*
		 * Create default user. If the user already exists, the user tables are
		 * being shared among sites. Just set the role in that case.
		 */
    $user_id        = username_exists( $user_name );
    $user_password  = trim( $user_password );
    $email_password = false;
    $user_created   = false;

    if ( ! $user_id && empty( $user_password ) ) {
      $user_password = wp_generate_password( 12, false );
      $message       = __( '<strong><em>Note that password</em></strong> carefully! It is a <em>random</em> password that was generated just for you.' );
      $user_id       = wp_create_user( $user_name, $user_password, $user_email );
      update_user_meta( $user_id, 'default_password_nag', true );
      $email_password = true;
      $user_created   = true;
    } elseif ( ! $user_id ) {
      // Password has been provided.
      $message      = '<em>' . __( 'Your chosen password.' ) . '</em>';
      $user_id      = wp_create_user( $user_name, $user_password, $user_email );
      $user_created = true;
    } else {
      $message = __( 'User already exists. Password inherited.' );
    }

    $user = new WP_User( $user_id );
    $user->set_role( 'administrator' );

    if ( $user_created ) {
      $user->user_url = $guessurl;
      wp_update_user( $user );
    }

    wp_install_defaults( $user_id );

    wp_install_maybe_enable_pretty_permalinks();

    flush_rewrite_rules();

    wp_new_blog_notification( $blog_title, $guessurl, $user_id, ( $email_password ? $user_password : __( 'The password you chose during installation.' ) ) );

    wp_cache_flush();

    
/**
 * Fires after a site is fully installed.
 *
 * @since 3.9.0
 *
 * @param WP_User $user The site owner.
 */
    do_action( 'wp_install', $user );

    return array(
      'url'              => $guessurl,
      'user_id'          => $user_id,
      'password'         => $user_password,
      'password_message' => $message,
    );
  }
 

 View on GitHub View on Trac