WP_PLUGIN_DIR and WP_PLUGIN_URL
- * in wp-config.php.
+ * manually, define `WP_PLUGIN_DIR` and `WP_PLUGIN_URL` in `wp-config.php`.
*
* @access private
* @since 3.1.0
- * @return array Files to include
+ *
+ * @return array Files to include.
*/
function wp_get_active_network_plugins() {
$active_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
@@ -66,17 +63,16 @@ function wp_get_active_network_plugins() {
* use the wp-content/blog-deleted.php, blog-inactive.php and
* blog-suspended.php drop-ins.
*
- * @return bool|string Returns true on success, or drop-in file to include.
+ * @since 3.0.0
+ *
+ * @return true|string Returns true on success, or drop-in file to include.
*/
function ms_site_check() {
- global $wpdb, $current_site;
-
- $blog = get_blog_details();
/**
- * Filter checking the status of the current blog.
+ * Filters checking the status of the current blog.
*
- * @since 1.2.1
+ * @since 3.0.0
*
* @param bool null Whether to skip the blog status check. Default null.
*/
@@ -88,18 +84,27 @@ function ms_site_check() {
if ( is_super_admin() )
return true;
+ $blog = get_blog_details();
+
if ( '1' == $blog->deleted ) {
if ( file_exists( WP_CONTENT_DIR . '/blog-deleted.php' ) )
return WP_CONTENT_DIR . '/blog-deleted.php';
else
- wp_die( __( 'This user has elected to delete their account and the content is no longer available.' ), '', array( 'response' => 410 ) );
+ wp_die( __( 'This site is no longer available.' ), '', array( 'response' => 410 ) );
}
if ( '2' == $blog->deleted ) {
- if ( file_exists( WP_CONTENT_DIR . '/blog-inactive.php' ) )
+ if ( file_exists( WP_CONTENT_DIR . '/blog-inactive.php' ) ) {
return WP_CONTENT_DIR . '/blog-inactive.php';
- else
- wp_die( sprintf( __( 'This site has not been activated yet. If you are having problems activating your site, please contact %1$s.' ), str_replace( '@', ' AT ', get_site_option( 'admin_email', "support@{$current_site->domain}" ) ) ) );
+ } else {
+ $admin_email = str_replace( '@', ' AT ', get_site_option( 'admin_email', 'support@' . get_current_site()->domain ) );
+ wp_die(
+ /* translators: %s: admin email link */
+ sprintf( __( 'This site has not been activated yet. If you are having problems activating your site, please contact %s.' ),
+ sprintf( '%s', $admin_email )
+ )
+ );
+ }
}
if ( $blog->archived == '1' || $blog->spam == '1' ) {
@@ -113,118 +118,331 @@ function ms_site_check() {
}
/**
- * Sets current site name.
+ * Retrieve the closest matching network for a domain and path.
*
- * @access private
- * @since 3.0.0
- * @return object $current_site object with site_name
+ * @since 3.9.0
+ *
+ * @internal In 4.4.0, converted to a wrapper for WP_Network::get_by_path()
+ *
+ * @param string $domain Domain to check.
+ * @param string $path Path to check.
+ * @param int|null $segments Path segments to use. Defaults to null, or the full path.
+ * @return WP_Network|false Network object if successful. False when no network is found.
*/
-function get_current_site_name( $current_site ) {
- global $wpdb;
+function get_network_by_path( $domain, $path, $segments = null ) {
+ return WP_Network::get_by_path( $domain, $path, $segments );
+}
- $current_site->site_name = wp_cache_get( $current_site->id . ':site_name', 'site-options' );
- if ( ! $current_site->site_name ) {
- $current_site->site_name = $wpdb->get_var( $wpdb->prepare( "SELECT meta_value FROM $wpdb->sitemeta WHERE site_id = %d AND meta_key = 'site_name'", $current_site->id ) );
- if ( ! $current_site->site_name )
- $current_site->site_name = ucfirst( $current_site->domain );
- wp_cache_set( $current_site->id . ':site_name', $current_site->site_name, 'site-options' );
+/**
+ * Retrieve an object containing information about the requested network.
+ *
+ * @since 3.9.0
+ *
+ * @internal In 4.6.0, converted to use get_network()
+ *
+ * @param object|int $network The network's database row or ID.
+ * @return WP_Network|false Object containing network information if found, false if not.
+ */
+function wp_get_network( $network ) {
+ $network = get_network( $network );
+ if ( null === $network ) {
+ return false;
}
- return $current_site;
+ return $network;
}
/**
- * Sets current_site object.
+ * Retrieve a site object by its domain and path.
*
- * @access private
- * @since 3.0.0
- * @return object $current_site object
+ * @since 3.9.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $domain Domain to check.
+ * @param string $path Path to check.
+ * @param int|null $segments Path segments to use. Defaults to null, or the full path.
+ * @return object|false Site object if successful. False when no site is found.
*/
-function wpmu_current_site() {
- global $wpdb, $current_site, $domain, $path, $sites, $cookie_domain;
+function get_site_by_path( $domain, $path, $segments = null ) {
+ $path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
- if ( empty( $current_site ) )
- $current_site = new stdClass;
+ /**
+ * Filters the number of path segments to consider when searching for a site.
+ *
+ * @since 3.9.0
+ *
+ * @param int|null $segments The number of path segments to consider. WordPress by default looks at
+ * one path segment following the network path. The function default of
+ * null only makes sense when you know the requested path should match a site.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path, in full.
+ */
+ $segments = apply_filters( 'site_by_path_segments_count', $segments, $domain, $path );
+
+ if ( null !== $segments && count( $path_segments ) > $segments ) {
+ $path_segments = array_slice( $path_segments, 0, $segments );
+ }
+ $paths = array();
+
+ while ( count( $path_segments ) ) {
+ $paths[] = '/' . implode( '/', $path_segments ) . '/';
+ array_pop( $path_segments );
+ }
+
+ $paths[] = '/';
+
+ /**
+ * Determine a site by its domain and path.
+ *
+ * This allows one to short-circuit the default logic, perhaps by
+ * replacing it with a routine that is more optimal for your setup.
+ *
+ * Return null to avoid the short-circuit. Return false if no site
+ * can be found at the requested domain and path. Otherwise, return
+ * a site object.
+ *
+ * @since 3.9.0
+ *
+ * @param null|bool|object $site Site value to return by path.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path, in full.
+ * @param int|null $segments The suggested number of paths to consult.
+ * Default null, meaning the entire path was to be consulted.
+ * @param array $paths The paths to search for, based on $path and $segments.
+ */
+ $pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
+ if ( null !== $pre ) {
+ return $pre;
+ }
+
+ /*
+ * @todo
+ * get_blog_details(), caching, etc. Consider alternative optimization routes,
+ * perhaps as an opt-in for plugins, rather than using the pre_* filter.
+ * For example: The segments filter can expand or ignore paths.
+ * If persistent caching is enabled, we could query the DB for a path <> '/'
+ * then cache whether we can just always ignore paths.
+ */
+
+ // Either www or non-www is supported, not both. If a www domain is requested,
+ // query for both to provide the proper redirect.
+ $domains = array( $domain );
+ if ( 'www.' === substr( $domain, 0, 4 ) ) {
+ $domains[] = substr( $domain, 4 );
+ }
+
+ $args = array(
+ 'domain__in' => $domains,
+ 'path__in' => $paths,
+ 'number' => 1,
+ );
+
+ if ( count( $domains ) > 1 ) {
+ $args['orderby']['domain_length'] = 'DESC';
+ }
+
+ if ( count( $paths ) > 1 ) {
+ $args['orderby']['path_length'] = 'DESC';
+ }
+
+ $result = get_sites( $args );
+ $site = array_shift( $result );
+
+ if ( $site ) {
+ // @todo get_blog_details()
+ return $site;
+ }
+
+ return false;
+}
+
+/**
+ * Identifies the network and site of a requested domain and path and populates the
+ * corresponding network and site global objects as part of the multisite bootstrap process.
+ *
+ * Prior to 4.6.0, this was a procedural block in `ms-settings.php`. It was wrapped into
+ * a function to facilitate unit tests. It should not be used outside of core.
+ *
+ * Usually, it's easier to query the site first, which then declares its network.
+ * In limited situations, we either can or must find the network first.
+ *
+ * If a network and site are found, a `true` response will be returned so that the
+ * request can continue.
+ *
+ * If neither a network or site is found, `false` or a URL string will be returned
+ * so that either an error can be shown or a redirect can occur.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @global WP_Network $current_site The current network.
+ * @global WP_Site $current_blog The current site.
+ *
+ * @param string $domain The requested domain.
+ * @param string $path The requested path.
+ * @param bool $subdomain Optional. Whether a subdomain (true) or subdirectory (false) configuration.
+ * Default false.
+ * @return bool|string True if bootstrap successfully populated `$current_blog` and `$current_site`.
+ * False if bootstrap could not be properly completed.
+ * Redirect URL if parts exist, but the request as a whole can not be fulfilled.
+ */
+function ms_load_current_site_and_network( $domain, $path, $subdomain = false ) {
+ global $wpdb, $current_site, $current_blog;
+
+ // If the network is defined in wp-config.php, we can simply use that.
if ( defined( 'DOMAIN_CURRENT_SITE' ) && defined( 'PATH_CURRENT_SITE' ) ) {
+ $current_site = new stdClass;
$current_site->id = defined( 'SITE_ID_CURRENT_SITE' ) ? SITE_ID_CURRENT_SITE : 1;
$current_site->domain = DOMAIN_CURRENT_SITE;
- $current_site->path = $path = PATH_CURRENT_SITE;
- if ( defined( 'BLOG_ID_CURRENT_SITE' ) )
+ $current_site->path = PATH_CURRENT_SITE;
+ if ( defined( 'BLOG_ID_CURRENT_SITE' ) ) {
$current_site->blog_id = BLOG_ID_CURRENT_SITE;
- elseif ( defined( 'BLOGID_CURRENT_SITE' ) ) // deprecated.
+ } elseif ( defined( 'BLOGID_CURRENT_SITE' ) ) { // deprecated.
$current_site->blog_id = BLOGID_CURRENT_SITE;
- if ( DOMAIN_CURRENT_SITE == $domain )
- $current_site->cookie_domain = $cookie_domain;
- elseif ( substr( $current_site->domain, 0, 4 ) == 'www.' )
- $current_site->cookie_domain = substr( $current_site->domain, 4 );
- else
- $current_site->cookie_domain = $current_site->domain;
+ }
- wp_load_core_site_options( $current_site->id );
+ if ( 0 === strcasecmp( $current_site->domain, $domain ) && 0 === strcasecmp( $current_site->path, $path ) ) {
+ $current_blog = get_site_by_path( $domain, $path );
+ } elseif ( '/' !== $current_site->path && 0 === strcasecmp( $current_site->domain, $domain ) && 0 === stripos( $path, $current_site->path ) ) {
+ // If the current network has a path and also matches the domain and path of the request,
+ // we need to look for a site using the first path segment following the network's path.
+ $current_blog = get_site_by_path( $domain, $path, 1 + count( explode( '/', trim( $current_site->path, '/' ) ) ) );
+ } else {
+ // Otherwise, use the first path segment (as usual).
+ $current_blog = get_site_by_path( $domain, $path, 1 );
+ }
+
+ } elseif ( ! $subdomain ) {
+ /*
+ * A "subdomain" install can be re-interpreted to mean "can support any domain".
+ * If we're not dealing with one of these installs, then the important part is determining
+ * the network first, because we need the network's path to identify any sites.
+ */
+ if ( ! $current_site = wp_cache_get( 'current_network', 'site-options' ) ) {
+ // Are there even two networks installed?
+ $one_network = $wpdb->get_row( "SELECT * FROM $wpdb->site LIMIT 2" ); // [sic]
+ if ( 1 === $wpdb->num_rows ) {
+ $current_site = new WP_Network( $one_network );
+ wp_cache_add( 'current_network', $current_site, 'site-options' );
+ } elseif ( 0 === $wpdb->num_rows ) {
+ // A network not found hook should fire here.
+ return false;
+ }
+ }
- return $current_site;
+ if ( empty( $current_site ) ) {
+ $current_site = WP_Network::get_by_path( $domain, $path, 1 );
+ }
+
+ if ( empty( $current_site ) ) {
+ /**
+ * Fires when a network cannot be found based on the requested domain and path.
+ *
+ * At the time of this action, the only recourse is to redirect somewhere
+ * and exit. If you want to declare a particular network, do so earlier.
+ *
+ * @since 4.4.0
+ *
+ * @param string $domain The domain used to search for a network.
+ * @param string $path The path used to search for a path.
+ */
+ do_action( 'ms_network_not_found', $domain, $path );
+
+ return false;
+ } elseif ( $path === $current_site->path ) {
+ $current_blog = get_site_by_path( $domain, $path );
+ } else {
+ // Search the network path + one more path segment (on top of the network path).
+ $current_blog = get_site_by_path( $domain, $path, substr_count( $current_site->path, '/' ) );
+ }
+ } else {
+ // Find the site by the domain and at most the first path segment.
+ $current_blog = get_site_by_path( $domain, $path, 1 );
+ if ( $current_blog ) {
+ $current_site = WP_Network::get_instance( $current_blog->site_id ? $current_blog->site_id : 1 );
+ } else {
+ // If you don't have a site with the same domain/path as a network, you're pretty screwed, but:
+ $current_site = WP_Network::get_by_path( $domain, $path, 1 );
+ }
}
- $current_site = wp_cache_get( 'current_site', 'site-options' );
- if ( $current_site )
- return $current_site;
-
- $sites = $wpdb->get_results( "SELECT * FROM $wpdb->site" ); // usually only one site
- if ( 1 == count( $sites ) ) {
- $current_site = $sites[0];
- wp_load_core_site_options( $current_site->id );
- $path = $current_site->path;
- $current_site->blog_id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s", $current_site->domain, $current_site->path ) );
- $current_site = get_current_site_name( $current_site );
- if ( substr( $current_site->domain, 0, 4 ) == 'www.' )
- $current_site->cookie_domain = substr( $current_site->domain, 4 );
- wp_cache_set( 'current_site', $current_site, 'site-options' );
- return $current_site;
+ // The network declared by the site trumps any constants.
+ if ( $current_blog && $current_blog->site_id != $current_site->id ) {
+ $current_site = WP_Network::get_instance( $current_blog->site_id );
}
- $path = substr( $_SERVER[ 'REQUEST_URI' ], 0, 1 + strpos( $_SERVER[ 'REQUEST_URI' ], '/', 1 ) );
- if ( $domain == $cookie_domain )
- $current_site = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->site WHERE domain = %s AND path = %s", $domain, $path ) );
- else
- $current_site = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->site WHERE domain IN ( %s, %s ) AND path = %s ORDER BY CHAR_LENGTH( domain ) DESC LIMIT 1", $domain, $cookie_domain, $path ) );
+ // No network has been found, bail.
+ if ( empty( $current_site ) ) {
+ /** This action is documented in wp-includes/ms-settings.php */
+ do_action( 'ms_network_not_found', $domain, $path );
- if ( ! $current_site ) {
- if ( $domain == $cookie_domain )
- $current_site = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->site WHERE domain = %s AND path='/'", $domain ) );
- else
- $current_site = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->site WHERE domain IN ( %s, %s ) AND path = '/' ORDER BY CHAR_LENGTH( domain ) DESC LIMIT 1", $domain, $cookie_domain, $path ) );
+ return false;
}
- if ( $current_site ) {
- $path = $current_site->path;
- $current_site->cookie_domain = $cookie_domain;
- return $current_site;
+ // During activation of a new subdomain, the requested site does not yet exist.
+ if ( empty( $current_blog ) && wp_installing() ) {
+ $current_blog = new stdClass;
+ $current_blog->blog_id = $blog_id = 1;
+ $current_blog->public = 1;
}
- if ( is_subdomain_install() ) {
- $sitedomain = substr( $domain, 1 + strpos( $domain, '.' ) );
- $current_site = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->site WHERE domain = %s AND path = %s", $sitedomain, $path) );
- if ( $current_site ) {
- $current_site->cookie_domain = $current_site->domain;
- return $current_site;
+ // No site has been found, bail.
+ if ( empty( $current_blog ) ) {
+ // We're going to redirect to the network URL, with some possible modifications.
+ $scheme = is_ssl() ? 'https' : 'http';
+ $destination = "$scheme://{$current_site->domain}{$current_site->path}";
+
+ /**
+ * Fires when a network can be determined but a site cannot.
+ *
+ * At the time of this action, the only recourse is to redirect somewhere
+ * and exit. If you want to declare a particular site, do so earlier.
+ *
+ * @since 3.9.0
+ *
+ * @param object $current_site The network that had been determined.
+ * @param string $domain The domain used to search for a site.
+ * @param string $path The path used to search for a site.
+ */
+ do_action( 'ms_site_not_found', $current_site, $domain, $path );
+
+ if ( $subdomain && ! defined( 'NOBLOGREDIRECT' ) ) {
+ // For a "subdomain" install, redirect to the signup form specifically.
+ $destination .= 'wp-signup.php?new=' . str_replace( '.' . $current_site->domain, '', $domain );
+ } elseif ( $subdomain ) {
+ // For a "subdomain" install, the NOBLOGREDIRECT constant
+ // can be used to avoid a redirect to the signup form.
+ // Using the ms_site_not_found action is preferred to the constant.
+ if ( '%siteurl%' !== NOBLOGREDIRECT ) {
+ $destination = NOBLOGREDIRECT;
+ }
+ } elseif ( 0 === strcasecmp( $current_site->domain, $domain ) ) {
+ /*
+ * If the domain we were searching for matches the network's domain,
+ * it's no use redirecting back to ourselves -- it'll cause a loop.
+ * As we couldn't find a site, we're simply not installed.
+ */
+ return false;
}
- $current_site = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->site WHERE domain = %s AND path='/'", $sitedomain) );
+ return $destination;
}
- if ( $current_site || defined( 'WP_INSTALLING' ) ) {
- $path = '/';
- return $current_site;
+ // Figure out the current network's main site.
+ if ( empty( $current_site->blog_id ) ) {
+ if ( $current_blog->domain === $current_site->domain && $current_blog->path === $current_site->path ) {
+ $current_site->blog_id = $current_blog->blog_id;
+ } elseif ( ! $current_site->blog_id = wp_cache_get( 'network:' . $current_site->id . ':main_site', 'site-options' ) ) {
+ $current_site->blog_id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s",
+ $current_site->domain, $current_site->path ) );
+ wp_cache_add( 'network:' . $current_site->id . ':main_site', $current_site->blog_id, 'site-options' );
+ }
}
- // Still no dice.
- wp_load_translations_early();
-
- if ( 1 == count( $sites ) )
- wp_die( sprintf( __( 'That site does not exist. Please try %s.' ), 'http://' . $sites[0]->domain . $sites[0]->path ) );
- else
- wp_die( __( 'No site defined on this host. If you are the owner of this site, please check Debugging a WordPress Network for help.' ) );
+ return true;
}
/**
@@ -234,24 +452,48 @@ function wpmu_current_site() {
*
* @access private
* @since 3.0.0
+ * @since 4.4.0 The `$domain` and `$path` parameters were added.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $domain The requested domain for the error to reference.
+ * @param string $path The requested path for the error to reference.
*/
-function ms_not_installed() {
- global $wpdb, $domain, $path;
+function ms_not_installed( $domain, $path ) {
+ global $wpdb;
+
+ if ( ! is_admin() ) {
+ dead_db();
+ }
wp_load_translations_early();
$title = __( 'Error establishing a database connection' );
+
$msg = '' . __( 'If your site does not display, please contact the owner of this network.' ) . ''; $msg .= ' ' . __( 'If you are the owner of this network please check that MySQL is running properly and all tables are error free.' ) . '
'; - if ( ! $wpdb->get_var( "SHOW TABLES LIKE '$wpdb->site'" ) ) - $msg .= '' . sprintf( __( 'Database tables are missing. This means that MySQL is not running, WordPress was not installed properly, or someone deleted %s. You really should look at your database now.' ), $wpdb->site ) . '
' . sprintf( __( 'Could not find site %1$s. Searched for table %2$s in database %3$s. Is that right?' ), rtrim( $domain . $path, '/' ), $wpdb->blogs, DB_NAME ) . '
' . sprintf(
+ /* translators: %s: table name */
+ __( 'Database tables are missing. This means that MySQL is not running, WordPress was not installed properly, or someone deleted %s. You really should look at your database now.' ),
+ '' . $wpdb->site . ''
+ ) . '
' . sprintf(
+ /* translators: 1: site url, 2: table name, 3: database name */
+ __( 'Could not find site %1$s. Searched for table %2$s in database %3$s. Is that right?' ),
+ '' . rtrim( $domain . $path, '/' ) . '',
+ '' . $wpdb->blogs . '',
+ '' . DB_NAME . ''
+ ) . '
' . __( 'What do I do now?' ) . ' '; - $msg .= __( 'Read the bug report page. Some of the guidelines there may help you figure out what went wrong.' ); + /* translators: %s: Codex URL */ + $msg .= sprintf( __( 'Read the bug report page. Some of the guidelines there may help you figure out what went wrong.' ), + __( 'https://codex.wordpress.org/Debugging_a_WordPress_Network' ) + ); $msg .= ' ' . __( 'If you’re still stuck with this message, then check that your database contains the following tables:' ) . '