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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

WP_Network|false

Network object if successful. False when no network is found.

Performance profile

How much work a call to WP_Network::get_by_path() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

32–97

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 128.

Plugin surface

2 hooks

Third-party callbacks on 'network_by_path_segments_count', 'pre_get_network_by_path' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Network::get_by_path() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

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

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

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

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

   Determines a network by its domain and path.

Uses · 3

• wp_using_ext_object_cache()Toggles `$_wp_using_ext_object_cache` on and off without directly touching global.
• get_networks()Retrieves a list of networks.
• apply_filters()Calls the callback functions that have been added to a filter hook.

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 code

View on Trac ↗View on GitHub ↗

338	public static function get_by_path( $domain = '', $path = '', $segments = null ) {339		$domains = array( $domain );340		$pieces  = explode( '.', $domain );341 342		/*343		 * It's possible one domain to search is 'com', but it might as well344		 * be 'localhost' or some other locally mapped domain.345		 */346		while ( array_shift( $pieces ) ) {347			if ( ! empty( $pieces ) ) {348				$domains[] = implode( '.', $pieces );349			}350		}351 352		/*353		 * If we've gotten to this function during normal execution, there is354		 * more than one network installed. At this point, who knows how many355		 * we have. Attempt to optimize for the situation where networks are356		 * only domains, thus meaning paths never need to be considered.357		 *358		 * This is a very basic optimization; anything further could have359		 * drawbacks depending on the setup, so this is best done per-installation.360		 */361		$using_paths = true;362		if ( wp_using_ext_object_cache() ) {363			$using_paths = get_networks(364				array(365					'number'       => 1,366					'count'        => true,367					'path__not_in' => '/',368				)369			);370		}371 372		$paths = array();373		if ( $using_paths ) {374			$path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );375 376			/**377			 * Filters the number of path segments to consider when searching for a site.378			 *379			 * @since 3.9.0380			 *381			 * @param int|null $segments The number of path segments to consider. WordPress by default looks at382			 *                           one path segment. The function default of null only makes sense when you383			 *                           know the requested path should match a network.384			 * @param string   $domain   The requested domain.385			 * @param string   $path     The requested path, in full.386			 */387			$segments = apply_filters( 'network_by_path_segments_count', $segments, $domain, $path );388 389			if ( ( null !== $segments ) && count( $path_segments ) > $segments ) {390				$path_segments = array_slice( $path_segments, 0, $segments );391			}392 393			while ( count( $path_segments ) ) {394				$paths[] = '/' . implode( '/', $path_segments ) . '/';395				array_pop( $path_segments );396			}397 398			$paths[] = '/';399		}400 401		/**402		 * Determines a network by its domain and path.403		 *404		 * This allows one to short-circuit the default logic, perhaps by405		 * replacing it with a routine that is more optimal for your setup.406		 *407		 * Return null to avoid the short-circuit. Return false if no network408		 * can be found at the requested domain and path. Otherwise, return409		 * an object from wp_get_network().410		 *411		 * @since 3.9.0412		 *413		 * @param null|false|WP_Network $network  Network value to return by path. Default null414		 *                                        to continue retrieving the network.415		 * @param string                $domain   The requested domain.416		 * @param string                $path     The requested path, in full.417		 * @param int|null              $segments The suggested number of paths to consult.

Changelog

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 7.1.0 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.