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.
Parameters
$sitenull|false|WP_Site
Site value to return by path. Default null to continue retrieving the site.
$domainstring
The requested domain.
$pathstring
The requested path, in full.
$segmentsint|null
The suggested number of paths to consult. Default null, meaning the entire path was to be consulted.
$pathsstring[]
The paths to search for, based on $path and $segments.
206* @param string$domain The requested domain.207* @param string$path The requested path, in full.208* @param int|null$segments The suggested number of paths to consult.209*Defaultnull, meaning the entire path was to be consulted.210* @param string[]$paths The paths to search for, based on$pathand$segments.211*/212$pre=apply_filters('pre_get_site_by_path',null,$domain,$path,$segments,$paths);213if(null!==$pre){214if(false!==$pre&&!$preinstanceofWP_Site){215$pre=newWP_Site($pre);216}217return$pre;218}
History
Introduced in 3.9.0. Unchanged from 6.7.7 through 7.1.0.