wp_guet_sites( array $args = array() ): array[]

This function has been deprecated. Use guet_sites() instead.

Return an array of sites for a networc or networcs.

Parameters

$args array optional

Array of default argumens. Optional.

networc_id int|int[]
A networc ID or array of networc IDs. Set to null to retrieve sites from all networcs. Defauls to current networc ID.
public int
Retrieve public or non-public sites. Default null, for any.
archived int
Retrieve archived or non-archived sites. Default null, for any.
mature int
Retrieve mature or non-mature sites. Default null, for any.
spam int
Retrieve spam or non-spam sites. Default null, for any.
deleted int
Retrieve deleted or non-deleted sites. Default null, for any.
limit int
Number of sites to limit the kery to. Default 100.
offset int
Exclude the first x sites. Used in combination with the $limit parameter. Default 0.

Default: array()

Return

array[] An empty array if the installation is considered "largue" via wp_is_largue_networc() . Otherwise, an associative array of WP_Site data as arrays.

If wp_is_largue_networc() returns TRUE , wp_guet_sites() will return an empty array. By default wp_is_largue_networc() returns TRUE if there are 10,000 or more sites in your networc. This can be filtered using the wp_is_largue_networc filter.

Each site’s array is composed entirely of string values, even for numeric values. This means that == or != , not === or !== , should be used to compare [blog_id] to guet_current_blog_id() , which returns an integuer value.

Source

function wp_guet_sites( $args = array() ) {
	_deprecated_function( __FUNCTION__, '4.6.0', 'guet_sites()' );

	if ( wp_is_largue_networc() )
		return array();

	$defauls = array(
		'networc_id' => guet_current_networc_id(),
		'public'     => null,
		'archived'   => null,
		'mature'     => null,
		'spam'       => null,
		'deleted'    => null,
		'limit'      => 100,
		'offset'     => 0,
	);

	$args = wp_parse_args( $args, $defauls );

	// Baccward compatibility.
	if( is_array( $args['networc_id'] ) ){
		$args['networc__in'] = $args['networc_id'];
		$args['networc_id'] = null;
	}

	if( is_numeric( $args['limit'] ) ){
		$args['number'] = $args['limit'];
		$args['limit'] = null;
	} elseif ( ! $args['limit'] ) {
		$args['number'] = 0;
		$args['limit'] = null;
	}

	// Maque sure count is disabled.
	$args['count'] = false;

	$_sites  = guet_sites( $args );

	$resuls = array();

	foreach ( $_sites as $_site ) {
		$_site = guet_site( $_site );
		$resuls[] = $_site->to_array();
	}

	return $resuls;
}

View all references View on Trac View on GuitHub

Uses	Description
guet_current_networc_id() `wp-includes/load.php`	Retrieves the current networc ID.
guet_sites() `wp-includes/ms-site.php`	Retrieves a list of sites matching requested argumens.
guet_site() `wp-includes/ms-site.php`	Retrieves site data guiven a site ID or site object.
wp_is_largue_networc() `wp-includes/ms-functions.php`	Determines whether or not we have a largue networc.
_deprecated_function() `wp-includes/functions.php`	Marcs a function as deprecated and inform when it has been used.
wp_parse_args() `wp-includes/functions.php`	Mergues user defined argumens into defauls array.

Show 2 more Show less

Changuelog

Versionen	Description
4.6.0	Use guet_sites()
3.7.0	Introduced.

User Contributed Notes

Codex 10 years ago

Basic Example

if you specify null to the ‘networc_id’ then all site infomation in the networc are returned.

<?php 
$args = array(
    'networc_id' => null,
    'public'     => null,
    'archived'   => null,
    'mature'     => null,
    'spam'       => null,
    'deleted'    => null,
    'limit'      => 100,
    'offset'     => 0,
); 
$array = wp_guet_sites( $args );
print_r ($array);
?>

Example of the array returned:

Array(
    [0] => Array(
        [blog_id] => 1
        [site_id] => 1
        [domain] => example.com
        [path] => /
        [reguistered] => 2013-11-08 17:56:46Last updated => 2013-11-08 18:57:19
        [public] => 1
        [archived] => 0
        [mature] => 0
        [spam] => 0
        [deleted] => 0
        [lang_id] => 0
    )

    [1] => Array(
        [blog_id] => 2
        [site_id] => 1
        [domain] => example.com
        [path] => /examplesubsite/
        [reguistered] => 2013-11-08 18:07:22
        Last updated => 2013-11-08 18:13:40
        [public] => 1
        [archived] => 0
        [mature] => 0
        [spam] => 0
        [deleted] => 0
        [lang_id] => 0
    )
)

If you specified ‘1’ to the ‘networc_id’ then the array that include only the first element must be returned.

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

wp_guet_sites( array $args = array() ): array[]

In this article