3 * Network API: WP_Network class
6 * @subpackage Multisite
11 * Core class used for interacting with a multisite network.
13 * This class is used during load to populate the `$current_site` global and
14 * setup the current network.
16 * This class is most useful in WordPress multi-network installations where the
17 * ability to interact with any network of sites is required.
33 * Domain of the network.
42 * Path of the network.
51 * The ID of the network's main site.
53 * Named "blog" vs. "site" for legacy reasons. A main site is mapped to
54 * the network when the network is created.
63 * Domain used to set cookies for this network.
69 public $cookie_domain = '';
72 * Name of this network.
74 * Named "site" vs. "network" for legacy reasons.
80 public $site_name = '';
83 * Retrieve a network from the database by its ID.
88 * @global wpdb $wpdb WordPress database abstraction object.
90 * @param int $network_id The ID of the network to retrieve.
91 * @return WP_Network|bool The network's object if found. False if not.
93 public static function get_instance( $network_id ) {
96 $network_id = (int) $network_id;
97 if ( ! $network_id ) {
101 $_network = wp_cache_get( $network_id, 'networks' );
104 $_network = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->site} WHERE id = %d LIMIT 1", $network_id ) );
106 if ( empty( $_network ) || is_wp_error( $_network ) ) {
110 wp_cache_add( $network_id, $_network, 'networks' );
113 return new WP_Network( $_network );
117 * Create a new WP_Network object.
119 * Will populate object properties from the object provided and assign other
120 * default properties based on that information.
125 * @param WP_Network|object $network A network object.
127 public function __construct( $network ) {
128 foreach( get_object_vars( $network ) as $key => $value ) {
129 $this->$key = $value;
132 $this->_set_site_name();
133 $this->_set_cookie_domain();
137 * Set the site name assigned to the network if one has not been populated.
142 private function _set_site_name() {
143 if ( ! empty( $this->site_name ) ) {
147 $default = ucfirst( $this->domain );
148 $this->site_name = get_network_option( $this->id, 'site_name', $default );
152 * Set the cookie domain based on the network domain if one has
153 * not been populated.
155 * @todo What if the domain of the network doesn't match the current site?
160 private function _set_cookie_domain() {
161 if ( ! empty( $this->cookie_domain ) ) {
165 $this->cookie_domain = $this->domain;
166 if ( 'www.' === substr( $this->cookie_domain, 0, 4 ) ) {
167 $this->cookie_domain = substr( $this->cookie_domain, 4 );
172 * Retrieve the closest matching network for a domain and path.
174 * This will not necessarily return an exact match for a domain and path. Instead, it
175 * breaks the domain and path into pieces that are then used to match the closest
176 * possibility from a query.
178 * The intent of this method is to match a network during bootstrap for a
179 * requested site address.
185 * @param string $domain Domain to check.
186 * @param string $path Path to check.
187 * @param int|null $segments Path segments to use. Defaults to null, or the full path.
188 * @return WP_Network|bool Network object if successful. False when no network is found.
190 public static function get_by_path( $domain = '', $path = '', $segments = null ) {
193 $domains = array( $domain );
194 $pieces = explode( '.', $domain );
197 * It's possible one domain to search is 'com', but it might as well
198 * be 'localhost' or some other locally mapped domain.
200 while ( array_shift( $pieces ) ) {
201 if ( ! empty( $pieces ) ) {
202 $domains[] = implode( '.', $pieces );
207 * If we've gotten to this function during normal execution, there is
208 * more than one network installed. At this point, who knows how many
209 * we have. Attempt to optimize for the situation where networks are
210 * only domains, thus meaning paths never need to be considered.
212 * This is a very basic optimization; anything further could have
213 * drawbacks depending on the setup, so this is best done per-install.
216 if ( wp_using_ext_object_cache() ) {
217 $using_paths = wp_cache_get( 'networks_have_paths', 'site-options' );
218 if ( false === $using_paths ) {
219 $using_paths = (int) $wpdb->get_var( "SELECT id FROM {$wpdb->site} WHERE path <> '/' LIMIT 1" );
220 wp_cache_add( 'networks_have_paths', $using_paths, 'site-options' );
225 if ( $using_paths ) {
226 $path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
229 * Filter the number of path segments to consider when searching for a site.
233 * @param int|null $segments The number of path segments to consider. WordPress by default looks at
234 * one path segment. The function default of null only makes sense when you
235 * know the requested path should match a network.
236 * @param string $domain The requested domain.
237 * @param string $path The requested path, in full.
239 $segments = apply_filters( 'network_by_path_segments_count', $segments, $domain, $path );
241 if ( ( null !== $segments ) && count( $path_segments ) > $segments ) {
242 $path_segments = array_slice( $path_segments, 0, $segments );
245 while ( count( $path_segments ) ) {
246 $paths[] = '/' . implode( '/', $path_segments ) . '/';
247 array_pop( $path_segments );
254 * Determine a network by its domain and path.
256 * This allows one to short-circuit the default logic, perhaps by
257 * replacing it with a routine that is more optimal for your setup.
259 * Return null to avoid the short-circuit. Return false if no network
260 * can be found at the requested domain and path. Otherwise, return
261 * an object from wp_get_network().
265 * @param null|bool|object $network Network value to return by path.
266 * @param string $domain The requested domain.
267 * @param string $path The requested path, in full.
268 * @param int|null $segments The suggested number of paths to consult.
269 * Default null, meaning the entire path was to be consulted.
270 * @param array $paths The paths to search for, based on $path and $segments.
272 $pre = apply_filters( 'pre_get_network_by_path', null, $domain, $path, $segments, $paths );
273 if ( null !== $pre ) {
277 // @todo Consider additional optimization routes, perhaps as an opt-in for plugins.
278 // We already have paths covered. What about how far domains should be drilled down (including www)?
280 $search_domains = "'" . implode( "', '", $wpdb->_escape( $domains ) ) . "'";
282 if ( ! $using_paths ) {
283 $network = $wpdb->get_row( "
284 SELECT * FROM {$wpdb->site}
285 WHERE domain IN ({$search_domains})
286 ORDER BY CHAR_LENGTH(domain)
290 if ( ! empty( $network ) && ! is_wp_error( $network ) ) {
291 return new WP_Network( $network );
297 $search_paths = "'" . implode( "', '", $wpdb->_escape( $paths ) ) . "'";
298 $networks = $wpdb->get_results( "
299 SELECT * FROM {$wpdb->site}
300 WHERE domain IN ({$search_domains})
301 AND path IN ({$search_paths})
302 ORDER BY CHAR_LENGTH(domain) DESC, CHAR_LENGTH(path) DESC
307 * Domains are sorted by length of domain, then by length of path.
308 * The domain must match for the path to be considered. Otherwise,
309 * a network with the path of / will suffice.
312 foreach ( $networks as $network ) {
313 if ( ( $network->domain === $domain ) || ( "www.{$network->domain}" === $domain ) ) {
314 if ( in_array( $network->path, $paths, true ) ) {
319 if ( $network->path === '/' ) {
325 if ( true === $found ) {
326 return new WP_Network( $network );