pre_get_network_by_path
Filter HookDescription
Determines a network 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 network can be found at the requested domain and path. Otherwise, return an object from wp_get_network().Hook Information
File Location |
wp-includes/class-wp-network.php
View on GitHub
|
Hook Type | Filter |
Line Number | 417 |
Hook Parameters
Type | Name | Description |
---|---|---|
null|false|WP_Network
|
$network
|
Network value to return by path. Default null to continue retrieving the network. |
string
|
$domain
|
The requested domain. |
string
|
$path
|
The requested path, in full. |
int|null
|
$segments
|
The suggested number of paths to consult. Default null, meaning the entire path was to be consulted. |
string[]
|
$paths
|
Array of paths to search for, based on `$path` and `$segments`. |
Usage Examples
Basic Usage
<?php
// Hook into pre_get_network_by_path
add_filter('pre_get_network_by_path', 'my_custom_filter', 10, 5);
function my_custom_filter($network, $domain, $path, $segments, $paths) {
// Your custom filtering logic here
return $network;
}
Source Code Context
wp-includes/class-wp-network.php:417
- How this hook is used in WordPress core
<?php
412 * @param string $path The requested path, in full.
413 * @param int|null $segments The suggested number of paths to consult.
414 * Default null, meaning the entire path was to be consulted.
415 * @param string[] $paths Array of paths to search for, based on `$path` and `$segments`.
416 */
417 $pre = apply_filters( 'pre_get_network_by_path', null, $domain, $path, $segments, $paths );
418 if ( null !== $pre ) {
419 return $pre;
420 }
421
422 if ( ! $using_paths ) {
PHP Documentation
<?php
/**
* Determines a network 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 network
* can be found at the requested domain and path. Otherwise, return
* an object from wp_get_network().
*
* @since 3.9.0
*
* @param null|false|WP_Network $network Network value to return by path. Default null
* to continue retrieving the network.
* @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 Array of paths to search for, based on `$path` and `$segments`.
*/
Quick Info
- Hook Type: Filter
- Parameters: 5
- File: wp-includes/class-wp-network.php
Related Hooks
Related hooks will be displayed here in future updates.