wppaste
WordPress

WP_Network::get_by_path( string $domain = '', string $path = '', int|null $segments = null ): WP_Network|false

Since
4.4.0
Source
wp-includes/class-wp-network.php:334
Retrieves the closest matching network for a domain and path.

Description

This will not necessarily return an exact match for a domain and path. Instead, it breaks the domain and path into pieces that are then used to match the closest possibility from a query. The intent of this method is to match a network during bootstrap for a requested site address.

Parameters

$domainstringoptional
Domain to check.Default: ''
$pathstringoptional
Path to check.Default: ''
$segmentsint|nulloptional
Path segments to use. Defaults to null, or the full path.Default: null

Return

WP_Network|false
Network object if successful. False when no network is found.

Hooks fired · 2

2 hooks fire while WP_Network::get_by_path() runs, in this order:

  1. apply_filters( network_by_path_segments_count )filterline 383 (+49 into the body)

    Filters the number of path segments to consider when searching for a site.

  2. apply_filters( pre_get_network_by_path )filterline 417 (+83 into the body)

    Determines a network by its domain and path.

Uses · 3

Used by · 2

  • get_network_by_path()Retrieves the closest matching network for a domain and path.
  • ms_load_current_site_and_network()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.

Source

	public static function get_by_path( $domain = '', $path = '', $segments = null ) {		$domains = array( $domain );		$pieces  = explode( '.', $domain ); 		/*		 * It's possible one domain to search is 'com', but it might as well		 * be 'localhost' or some other locally mapped domain.		 */		while ( array_shift( $pieces ) ) {			if ( ! empty( $pieces ) ) {				$domains[] = implode( '.', $pieces );			}		} 		/*		 * If we've gotten to this function during normal execution, there is		 * more than one network installed. At this point, who knows how many		 * we have. Attempt to optimize for the situation where networks are		 * only domains, thus meaning paths never need to be considered.		 *		 * This is a very basic optimization; anything further could have		 * drawbacks depending on the setup, so this is best done per-installation.		 */		$using_paths = true;		if ( wp_using_ext_object_cache() ) {			$using_paths = get_networks(				array(					'number'       => 1,					'count'        => true,					'path__not_in' => '/',				)			);		} 		$paths = array();		if ( $using_paths ) {			$path_segments = array_filter( explode( '/', trim( $path, '/' ) ) ); 			/**			 * 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. The function default of null only makes sense when you			 *                           know the requested path should match a network.			 * @param string   $domain   The requested domain.			 * @param string   $path     The requested path, in full.			 */			$segments = apply_filters( 'network_by_path_segments_count', $segments, $domain, $path ); 			if ( ( null !== $segments ) && count( $path_segments ) > $segments ) {				$path_segments = array_slice( $path_segments, 0, $segments );			} 			while ( count( $path_segments ) ) {				$paths[] = '/' . implode( '/', $path_segments ) . '/';				array_pop( $path_segments );			} 			$paths[] = '/';		} 		/**		 * Determines a network 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 network		 * can be found at the requested domain and path. Otherwise, return		 * an object from wp_get_network().		 *		 * @since 3.9.0		 *		 * @param null|false|WP_Network $network  Network value to return by path. Default null		 *                                        to continue retrieving the network.		 * @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.

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-network.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.