get_network( WP_Network|int|null $network = null ): WP_Network|null

Retrieves network data given a network ID or network object.

Description

Network data will be cached and returned after being passed through a filter.
If the provided network is empty, the current network global will be used.

Parameters

$networkWP_Network|int|nulloptional
Network to retrieve. Default is the current network.

Default:null

Return

WP_Network|null The network object or null if not found.

Source

function get_network( $network = null ) {
	global $current_site;
	if ( empty( $network ) && isset( $current_site ) ) {
		$network = $current_site;
	}

	if ( $network instanceof WP_Network ) {
		$_network = $network;
	} elseif ( is_object( $network ) ) {
		$_network = new WP_Network( $network );
	} else {
		$_network = WP_Network::get_instance( $network );
	}

	if ( ! $_network ) {
		return null;
	}

	/**
	 * Fires after a network is retrieved.
	 *
	 * @since 4.6.0
	 *
	 * @param WP_Network $_network Network data.
	 */
	$_network = apply_filters( 'get_network', $_network );

	return $_network;
}

Hooks

apply_filters( ‘get_network’, WP_Network $_network )

Fires after a network is retrieved.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

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