WordPress Hooks Explorer

Listing all hooks extracted WordPress Core


Details about pre_get_site_by_path

Back to home

Files

Filename Hook Type Line Number PHP Doc
wp-includes/ms-load.php apply_filters 212 /**
* Determines a site 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 site
* can be found at the requested domain and path. Otherwise, return
* a site object.
*
* @since 3.9.0
*
* @param null|false|WP_Site $site Site value to return by path. Default null
* to continue retrieving the site.
* @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.
* Default null, meaning the entire path was to be consulted.
* @param string[] $paths The paths to search for, based on $path and $segments.
*/

Hook Parameters

Parameter Type Name Description
null|false|WP_Site $site Site value to return by path. Default null
string $domain The requested domain.
string $path The requested path, in full.
int|null $segments The suggested number of paths to consult.
string[] $paths The paths to search for, based on $path and $segments.