3 * Network installation administration panel.
5 * A multi-step process allowing the user to enable a network of WordPress sites.
10 * @subpackage Administration
13 define( 'WP_NETWORK_ADMIN_PAGE', true );
15 /** WordPress Administration Bootstrap */
16 require_once( './admin.php' );
18 if ( ! is_super_admin() )
19 wp_die( __( 'You do not have sufficient permissions to manage options for this site.' ) );
21 if ( is_multisite() && ! defined( 'MULTISITE' ) )
22 wp_die( __( 'The Network creation panel is not for WordPress MU networks.' ) );
24 // We need to create references to ms global tables to enable Network.
25 foreach ( $wpdb->tables( 'ms_global' ) as $table => $prefixed_table )
26 $wpdb->$table = $prefixed_table;
29 * Check for an existing network.
32 * @return Whether a network exists.
34 function network_domain_check() {
36 if ( $wpdb->get_var( "SHOW TABLES LIKE '$wpdb->site'" ) )
37 return $wpdb->get_var( "SELECT domain FROM $wpdb->site ORDER BY id ASC LIMIT 1" );
42 * Allow subdomain install
45 * @return bool Whether subdomain install is allowed
47 function allow_subdomain_install() {
48 $domain = preg_replace( '|https?://([^/]+)|', '$1', get_option( 'siteurl' ) );
49 if( false !== strpos( $domain, '/' ) || 'localhost' == $domain || preg_match( '|[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+|', $domain ) )
55 * Allow subdirectory install
58 * @return bool Whether subdirectory install is allowed
60 function allow_subdirectory_install() {
62 if ( apply_filters( 'allow_subdirectory_install', false ) )
65 if ( defined( 'ALLOW_SUBDIRECTORY_INSTALL' ) && ALLOW_SUBDIRECTORY_INSTALL )
68 $post = $wpdb->get_row( "SELECT ID FROM $wpdb->posts WHERE post_date < DATE_SUB(NOW(), INTERVAL 1 MONTH) AND post_status = 'publish'" );
75 * Get base domain of network.
78 * @return string Base domain.
80 function get_clean_basedomain() {
81 if ( $existing_domain = network_domain_check() )
82 return $existing_domain;
83 $domain = preg_replace( '|https?://|', '', get_option( 'siteurl' ) );
84 if ( $slash = strpos( $domain, '/' ) )
85 $domain = substr( $domain, 0, $slash );
89 if ( ! network_domain_check() && ( ! defined( 'WP_ALLOW_MULTISITE' ) || ! WP_ALLOW_MULTISITE ) )
90 wp_die( __( 'You must define the <code>WP_ALLOW_MULTISITE</code> constant as true in your wp-config.php file to allow creation of a Network.' ) );
92 $title = __( 'Create a Network of WordPress Sites' );
93 $parent_file = 'tools.php';
95 add_contextual_help($current_screen,
96 '<p>' . __('This screen allows you to configure a network as having subdomains (<code>site1.example.com</code>) or subdirectories (<code>example.com/site1</code>). Subdomains require wildcard subdomains to be enabled in Apache and DNS records, if your host allows it.') . '</p>' .
97 '<p>' . __('Choose subdomains or subdirectories; this can only be switched afterwards by reconfiguring your install. Fill out the network details, and click install. If this does not work, you may have to add a wildcard DNS record (for subdomains) or change to another setting in Permalinks (for subdirectories).') . '</p>' .
98 '<p>' . __('The next screen for Network will give you individually-generated lines of code to add to your wp-config.php and .htaccess files. Make sure the settings of your FTP client make files starting with a dot visible, so that you can find .htaccess; you may have to create this file if it really is not there. Make backup copies of those two files.') . '</p>' .
99 '<p>' . __('Add a <code>blogs.dir</code> directory under <code>/wp-content</code> and add the designated lines of code to wp-config.php (just before <code>/*...stop editing...*/</code>) and <code>.htaccess</code> (replacing the existing WordPress rules).') . '</p>' .
100 '<p>' . __('Refreshing your browser will take you to a screen with an archive of those added lines of code. A set of six links under Super Admin will appear at the top of the main left navigation menu. The multisite network is now enabled.') . '</p>' .
101 '<p>' . __('The choice of subdirectory sites is disabled if this setup is more than a month old because of permalink problems with “/blog/” from the main site. This disabling will be addressed soon in a future version.') . '</p>' .
102 '<p><strong>' . __('For more information:') . '</strong></p>' .
103 '<p>' . __('<a href="http://codex.wordpress.org/Create_A_Network" target="_blank">General Network Creation Documentation</a>') . '</p>' .
104 '<p>' . __('<a href="http://codex.wordpress.org/Tools_Network_SubPanel" target="_blank">Tools > Network Documentation</a>') . '</p>' .
105 '<p>' . __('<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
108 include( './admin-header.php' );
111 <?php screen_icon(); ?>
112 <h2><?php echo esc_html( $title ); ?></h2>
116 * Prints step 1 for Network installation process.
118 * @todo Realistically, step 1 should be a welcome screen explaining what a Network is and such. Navigating to Tools > Network
119 * should not be a sudden "Welcome to a new install process! Fill this out and click here." See also contextual help todo.
123 function network_step1( $errors = false ) {
126 if ( get_option( 'siteurl' ) != get_option( 'home' ) ) {
127 echo '<div class="error"><p><strong>' . __('Error:') . '</strong> ' . sprintf( __( 'Your <strong>WordPress address</strong> must match your <strong>Site address</strong> before creating a Network. See <a href="%s">General Settings</a>.' ), esc_url( admin_url( 'options-general.php' ) ) ) . '</p></div>';
129 include ('./admin-footer.php' );
133 $active_plugins = get_option( 'active_plugins' );
134 if ( ! empty( $active_plugins ) ) {
135 echo '<div class="updated"><p><strong>' . __('Warning:') . '</strong> ' . sprintf( __( 'Please <a href="%s">deactivate your plugins</a> before enabling the Network feature.' ), admin_url( 'plugins.php?plugin_status=active' ) ) . '</p></div><p>' . __( 'Once the network is created, you may reactivate your plugins.' ) . '</p>';
137 include( './admin-footer.php' );
141 $hostname = get_clean_basedomain();
142 $has_ports = strstr( $hostname, ':' );
143 if ( ( false !== $has_ports && ! in_array( $has_ports, array( ':80', ':443' ) ) ) ) {
144 echo '<div class="error"><p><strong>' . __( 'Error:') . '</strong> ' . __( 'You cannot install a network of sites with your server address.' ) . '</p></div>';
145 echo '<p>' . sprintf( __( 'You cannot use port numbers such as <code>%s</code>.' ), $has_ports ) . '</p>';
146 echo '<a href="' . esc_url( admin_url() ) . '">' . __( 'Return to Dashboard' ) . '</a>';
148 include( './admin-footer.php' );
152 echo '<form method="post" action="">';
154 wp_nonce_field( 'install-network-1' );
156 $error_codes = array();
157 if ( is_wp_error( $errors ) ) {
158 echo '<div class="error"><p><strong>' . __( 'ERROR: The network could not be created.' ) . '</strong></p>';
159 foreach ( $errors->get_error_messages() as $error )
160 echo "<p>$error</p>";
162 $error_codes = $errors->get_error_codes();
165 if ( WP_CONTENT_DIR != ABSPATH . 'wp-content' )
166 echo '<div class="error"><p><strong>' . __('Warning!') . '</strong> ' . __( 'Networks may not be fully compatible with custom wp-content directories.' ) . '</p></div>';
168 $site_name = ( ! empty( $_POST['sitename'] ) && ! in_array( 'empty_sitename', $error_codes ) ) ? $_POST['sitename'] : sprintf( _x('%s Sites', 'Default network name' ), get_option( 'blogname' ) );
169 $admin_email = ( ! empty( $_POST['email'] ) && ! in_array( 'invalid_email', $error_codes ) ) ? $_POST['email'] : get_option( 'admin_email' );
171 <p><?php _e( 'Welcome to the Network installation process!' ); ?></p>
172 <p><?php _e( 'Fill in the information below and you’ll be on your way to creating a network of WordPress sites. We will create configuration files in the next step.' ); ?></p>
175 if ( isset( $_POST['subdomain_install'] ) ) {
176 $subdomain_install = (bool) $_POST['subdomain_install'];
177 } elseif ( apache_mod_loaded('mod_rewrite') ) { // assume nothing
178 $subdomain_install = true;
179 } elseif ( !allow_subdirectory_install() ) {
180 $subdomain_install = true;
182 $subdomain_install = false;
183 if ( $got_mod_rewrite = got_mod_rewrite() ) // dangerous assumptions
184 echo '<div class="updated inline"><p><strong>' . __( 'Note:' ) . '</strong> ' . __( 'Please make sure the Apache <code>mod_rewrite</code> module is installed as it will be used at the end of this installation.' ) . '</p>';
185 elseif ( $is_apache )
186 echo '<div class="error inline"><p><strong>' . __( 'Warning!' ) . '</strong> ' . __( 'It looks like the Apache <code>mod_rewrite</code> module is not installed.' ) . '</p>';
187 if ( $got_mod_rewrite || $is_apache ) // Protect against mod_rewrite mimicry (but ! Apache)
188 echo '<p>' . __( 'If <code>mod_rewrite</code> is disabled, ask your administrator to enable that module, or look at the <a href="http://httpd.apache.org/docs/mod/mod_rewrite.html">Apache documentation</a> or <a href="http://www.google.com/search?q=apache+mod_rewrite">elsewhere</a> for help setting it up.' ) . '</p></div>';
191 if ( allow_subdomain_install() && allow_subdirectory_install() ) : ?>
192 <h3><?php esc_html_e( 'Addresses of Sites in your Network' ); ?></h3>
193 <p><?php _e( 'Please choose whether you would like sites in your WordPress network to use sub-domains or sub-directories. <strong>You cannot change this later.</strong>' ); ?></p>
194 <p><?php _e( 'You will need a wildcard DNS record if you are going to use the virtual host (sub-domain) functionality.' ); ?></p>
195 <?php // @todo: Link to an MS readme? ?>
196 <table class="form-table">
198 <th><label><input type='radio' name='subdomain_install' value='1'<?php checked( $subdomain_install ); ?> /> <?php _e( 'Sub-domains' ); ?></label></th>
199 <td><?php printf( _x( 'like <code>site1.%1$s</code> and <code>site2.%1$s</code>', 'subdomain examples' ), $hostname ); ?></td>
202 <th><label><input type='radio' name='subdomain_install' value='0'<?php checked( ! $subdomain_install ); ?> /> <?php _e( 'Sub-directories' ); ?></label></th>
203 <td><?php printf( _x( 'like <code>%1$s/site1</code> and <code>%1$s/site2</code>', 'subdirectory examples' ), $hostname ); ?></td>
210 $is_www = ( 0 === strpos( $hostname, 'www.' ) );
213 <h3><?php esc_html_e( 'Server Address' ); ?></h3>
214 <p><?php printf( __( 'We recommend you change your siteurl to <code>%1$s</code> before enabling the network feature. It will still be possible to visit your site using the <code>www</code> prefix with an address like <code>%2$s</code> but any links will not have the <code>www</code> prefix.' ), substr( $hostname, 4 ), $hostname ); ?></h3>
215 <table class="form-table">
217 <th scope='row'><?php esc_html_e( 'Server Address' ); ?></th>
219 <?php printf( __( 'The internet address of your network will be <code>%s</code>.' ), $hostname ); ?>
225 <h3><?php esc_html_e( 'Network Details' ); ?></h3>
226 <table class="form-table">
227 <?php if ( 'localhost' == $hostname ) : ?>
229 <th scope="row"><?php esc_html_e( 'Sub-directory Install' ); ?></th>
231 _e( 'Because you are using <code>localhost</code>, the sites in your WordPress network must use sub-directories. Consider using <code>localhost.localdomain</code> if you wish to use sub-domains.' );
233 if ( !allow_subdirectory_install() )
234 echo ' <strong>' . __( 'Warning!' ) . ' ' . __( 'The main site in a sub-directory install will need to use a modified permalink structure, potentially breaking existing links.' ) . '</strong>';
237 <?php elseif ( !allow_subdomain_install() ) : ?>
239 <th scope="row"><?php esc_html_e( 'Sub-directory Install' ); ?></th>
241 _e( 'Because your install is in a directory, the sites in your WordPress network must use sub-directories.' );
243 if ( !allow_subdirectory_install() )
244 echo ' <strong>' . __( 'Warning!' ) . ' ' . __( 'The main site in a sub-directory install will need to use a modified permalink structure, potentially breaking existing links.' ) . '</strong>';
247 <?php elseif ( !allow_subdirectory_install() ) : ?>
249 <th scope="row"><?php esc_html_e( 'Sub-domain Install' ); ?></th>
250 <td><?php _e( 'Because your install is not new, the sites in your WordPress network must use sub-domains.' );
251 echo ' <strong>' . __( 'The main site in a sub-directory install will need to use a modified permalink structure, potentially breaking existing links.' ) . '</strong>';
255 <?php if ( ! $is_www ) : ?>
257 <th scope='row'><?php esc_html_e( 'Server Address' ); ?></th>
259 <?php printf( __( 'The internet address of your network will be <code>%s</code>.' ), $hostname ); ?>
264 <th scope='row'><?php esc_html_e( 'Network Title' ); ?></th>
266 <input name='sitename' type='text' size='45' value='<?php echo esc_attr( $site_name ); ?>' />
267 <br /><?php _e( 'What would you like to call your network?' ); ?>
271 <th scope='row'><?php esc_html_e( 'Admin E-mail Address' ); ?></th>
273 <input name='email' type='text' size='45' value='<?php echo esc_attr( $admin_email ); ?>' />
274 <br /><?php _e( 'Your email address.' ); ?>
278 <p class='submit'><input class="button-primary" name='submit' type='submit' value='<?php esc_attr_e( 'Install' ); ?>' /></p>
284 * Prints step 2 for Network installation process.
288 function network_step2( $errors = false ) {
290 $hostname = get_clean_basedomain();
292 // Wildcard DNS message.
293 if ( is_wp_error( $errors ) )
294 echo '<div class="error">' . $errors->get_error_message() . '</div>';
297 $subdomain_install = allow_subdomain_install() ? ( allow_subdirectory_install() ? ! empty( $_POST['subdomain_install'] ) : true ) : false;
299 if ( is_multisite() ) {
300 $subdomain_install = is_subdomain_install();
302 <div class="updated"><p><strong><?php _e( 'Notice: The Network feature is already enabled.' ); ?></strong> <?php _e( 'The original configuration steps are shown here for reference.' ); ?></p></div>
304 $subdomain_install = (bool) $wpdb->get_var( "SELECT meta_value FROM $wpdb->sitemeta WHERE site_id = 1 AND meta_key = 'subdomain_install'" );
306 <div class="error"><p><strong><?php _e('Warning:'); ?></strong> <?php _e( 'An existing WordPress network was detected.' ); ?></p></div>
307 <p><?php _e( 'Please complete the configuration steps. To create a new network, you will need to empty or remove the network database tables.' ); ?></p>
312 if ( $_POST || ! is_multisite() ) {
314 <h3><?php esc_html_e( 'Enabling the Network' ); ?></h3>
315 <p><?php _e( 'Complete the following steps to enable the features for creating a network of sites.' ); ?></p>
316 <div class="updated inline"><p><?php
317 if ( iis7_supports_permalinks() )
318 _e( '<strong>Caution:</strong> We recommend you back up your existing <code>wp-config.php</code> file.' );
320 _e( '<strong>Caution:</strong> We recommend you back up your existing <code>wp-config.php</code> and <code>.htaccess</code> files.' );
327 printf( __( 'Create a <code>blogs.dir</code> directory in <code>%s</code>. This directory is used to stored uploaded media for your additional sites and must be writeable by the web server.' ), WP_CONTENT_DIR );
328 if ( WP_CONTENT_DIR != ABSPATH . 'wp-content' )
329 echo ' <strong>' . __('Warning:') . ' ' . __( 'Networks may not be fully compatible with custom wp-content directories.' ) . '</strong';
331 <li><p><?php printf( __( 'Add the following to your <code>wp-config.php</code> file in <code>%s</code> <strong>above</strong> the line reading <code>/* That’s all, stop editing! Happy blogging. */</code>:' ), ABSPATH ); ?></p>
332 <textarea class="code" readonly="readonly" cols="100" rows="7">
333 define( 'MULTISITE', true );
334 define( 'SUBDOMAIN_INSTALL', <?php echo $subdomain_install ? 'true' : 'false'; ?> );
335 $base = '<?php echo $base; ?>';
336 define( 'DOMAIN_CURRENT_SITE', '<?php echo $hostname; ?>' );
337 define( 'PATH_CURRENT_SITE', '<?php echo $base; ?>' );
338 define( 'SITE_ID_CURRENT_SITE', 1 );
339 define( 'BLOG_ID_CURRENT_SITE', 1 );</textarea>
341 $keys_salts = array( 'AUTH_KEY' => '', 'SECURE_AUTH_KEY' => '', 'LOGGED_IN_KEY' => '', 'NONCE_KEY' => '', 'AUTH_SALT' => '', 'SECURE_AUTH_SALT' => '', 'LOGGED_IN_SALT' => '', 'NONCE_SALT' => '' );
342 foreach ( $keys_salts as $c => $v ) {
344 unset( $keys_salts[ $c ] );
346 if ( ! empty( $keys_salts ) ) {
347 $from_api = wp_remote_get( 'https://api.wordpress.org/secret-key/1.1/salt/' );
348 if ( is_wp_error( $from_api ) ) {
349 foreach ( $keys_salts as $c => $v ) {
350 $keys_salts[ $c ] = wp_generate_password( 64, true, true );
353 $from_api = explode( "\n", wp_remote_retrieve_body( $from_api ) );
354 foreach ( $keys_salts as $c => $v ) {
355 $keys_salts[ $c ] = substr( array_shift( $from_api ), 28, 64 );
358 $num_keys_salts = count( $keys_salts );
361 echo _n( 'This unique authentication key is also missing from your <code>wp-config.php</code> file.', 'These unique authentication keys are also missing from your <code>wp-config.php</code> file.', $num_keys_salts ); ?> <?php _e( 'To make your installation more secure, you should also add:' ) ?></p>
362 <textarea class="code" readonly="readonly" cols="100" rows="<?php echo $num_keys_salts; ?>"><?php
363 foreach ( $keys_salts as $c => $v ) {
364 echo "\ndefine( '$c', '$v' );";
372 if ( iis7_supports_permalinks() ) :
374 if ( $subdomain_install ) {
376 '<?xml version="1.0" encoding="UTF-8"?>
381 <rule name="WordPress Rule 1" stopProcessing="true">
382 <match url="^index\.php$" ignoreCase="false" />
383 <action type="None" />
385 <rule name="WordPress Rule 2" stopProcessing="true">
386 <match url="^files/(.+)" ignoreCase="false" />
387 <action type="Rewrite" url="wp-includes/ms-files.php?file={R:1}" appendQueryString="false" />
389 <rule name="WordPress Rule 3" stopProcessing="true">
390 <match url="^" ignoreCase="false" />
391 <conditions logicalGrouping="MatchAny">
392 <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" />
393 <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" />
395 <action type="None" />
397 <rule name="WordPress Rule 4" stopProcessing="true">
398 <match url="." ignoreCase="false" />
399 <action type="Rewrite" url="index.php" />
407 '<?xml version="1.0" encoding="UTF-8"?>
412 <rule name="WordPress Rule 1" stopProcessing="true">
413 <match url="^index\.php$" ignoreCase="false" />
414 <action type="None" />
416 <rule name="WordPress Rule 2" stopProcessing="true">
417 <match url="^([_0-9a-zA-Z-]+/)?files/(.+)" ignoreCase="false" />
418 <action type="Rewrite" url="wp-includes/ms-files.php?file={R:2}" appendQueryString="false" />
420 <rule name="WordPress Rule 3" stopProcessing="true">
421 <match url="^([_0-9a-zA-Z-]+/)?wp-admin$" ignoreCase="false" />
422 <action type="Redirect" url="{R:1}wp-admin/" redirectType="Permanent" />
424 <rule name="WordPress Rule 4" stopProcessing="true">
425 <match url="^" ignoreCase="false" />
426 <conditions logicalGrouping="MatchAny">
427 <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" />
428 <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" />
430 <action type="None" />
432 <rule name="WordPress Rule 5" stopProcessing="true">
433 <match url="^([_0-9a-zA-Z-]+/)?(wp-(content|admin|includes).*)" ignoreCase="false" />
434 <action type="Rewrite" url="{R:2}" />
436 <rule name="WordPress Rule 6" stopProcessing="true">
437 <match url="^([_0-9a-zA-Z-]+/)?(.*\.php)$" ignoreCase="false" />
438 <action type="Rewrite" url="{R:2}" />
440 <rule name="WordPress Rule 7" stopProcessing="true">
441 <match url="." ignoreCase="false" />
442 <action type="Rewrite" url="index.php" />
450 <li><p><?php printf( __( 'Add the following to your <code>web.config</code> file in <code>%s</code>, replacing other WordPress rules:' ), ABSPATH ); ?></p>
451 <textarea class="code" readonly="readonly" cols="100" rows="20">
452 <?php echo wp_htmledit_pre( $web_config_file ); ?>
456 <?php else : // end iis7_supports_permalinks(). construct an htaccess file instead:
458 $htaccess_file = 'RewriteEngine On
459 RewriteBase ' . $base . '
460 RewriteRule ^index\.php$ - [L]
463 RewriteRule ^' . ( $subdomain_install ? '' : '([_0-9a-zA-Z-]+/)?' ) . 'files/(.+) wp-includes/ms-files.php?file=$' . ( $subdomain_install ? 1 : 2 ) . ' [L]' . "\n";
465 if ( ! $subdomain_install )
466 $htaccess_file .= "\n# add a trailing slash to /wp-admin\n" . 'RewriteRule ^([_0-9a-zA-Z-]+/)?wp-admin$ $1wp-admin/ [R=301,L]' . "\n";
468 $htaccess_file .= "\n" . 'RewriteCond %{REQUEST_FILENAME} -f [OR]
469 RewriteCond %{REQUEST_FILENAME} -d
470 RewriteRule ^ - [L]';
472 // @todo custom content dir.
473 if ( ! $subdomain_install )
474 $htaccess_file .= "\nRewriteRule ^([_0-9a-zA-Z-]+/)?(wp-(content|admin|includes).*) $2 [L]\nRewriteRule ^([_0-9a-zA-Z-]+/)?(.*\.php)$ $2 [L]";
476 $htaccess_file .= "\nRewriteRule . index.php [L]";
479 <li><p><?php printf( __( 'Add the following to your <code>.htaccess</code> file in <code>%s</code>, replacing other WordPress rules:' ), ABSPATH ); ?></p>
480 <textarea class="code" readonly="readonly" cols="100" rows="<?php echo $subdomain_install ? 11 : 16; ?>">
481 <?php echo wp_htmledit_pre( $htaccess_file ); ?></textarea></li>
484 <?php endif; // end IIS/Apache code branches.
486 if ( !is_multisite() ) { ?>
487 <p><?php printf( __( 'Once you complete these steps, your network is enabled and configured. You will have to log in again.') ); ?> <a href="<?php echo esc_url( site_url( 'wp-login.php' ) ); ?>"><?php _e( 'Log In' ); ?></a></p>
492 $base = trailingslashit( stripslashes( dirname( dirname( $_SERVER['SCRIPT_NAME'] ) ) ) );
495 check_admin_referer( 'install-network-1' );
497 require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
498 // create network tables
500 $hostname = get_clean_basedomain();
501 $subdomain_install = !allow_subdomain_install() ? false : (bool) $_POST['subdomain_install'];
502 if ( ! network_domain_check() ) {
503 $result = populate_network( 1, get_clean_basedomain(), sanitize_email( $_POST['email'] ), stripslashes( $_POST['sitename'] ), $base, $subdomain_install );
504 if ( is_wp_error( $result ) ) {
505 if ( 1 == count( $result->get_error_codes() ) && 'no_wildcard_dns' == $result->get_error_code() )
506 network_step2( $result );
508 network_step1( $result );
515 } elseif ( is_multisite() || network_domain_check() ) {
523 <?php include( './admin-footer.php' ); ?>