pre_get_site_by_path

Advertisement

Summery Summery

Determine a site by its domain and path.

Syntax Syntax

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

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

Parameters Parameters

$site

Site value to return by path. Default null to continue retrieving the site.

$domain

The requested domain.

$path

The requested path, in full.

$segments

The suggested number of paths to consult. Default null, meaning the entire path was to be consulted.

$paths

The paths to search for, based on $path and $segments.

Source Source

File: wp-includes/ms-load.php

Advertisement

Changelog Changelog

Changelog
Version Description
3.9.0 Introduced.

Advertisement

Leave a Reply