apply_filters( 'pre_get_site_by_path', null|false|WP_Site $site, string $domain, string $path, int|null $segments, string[] $paths )

Determines a site by its domain and path.


Description

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.


Top ↑

Parameters

$site null|false|WP_Site
Site value to return by path. Default null to continue retrieving the site.
$domain string
The requested domain.
$path string
The requested path, in full.
$segments int|null
The suggested number of paths to consult.
Default null, meaning the entire path was to be consulted.
$paths string[]
The paths to search for, based on $path and $segments.

Top ↑

Source

File: wp-includes/ms-load.php. View all references

$pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );


Top ↑

Changelog

Changelog
Version Description
3.9.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.