Description
The mainwp_getgroups filter may be used to retrieve information about the groups added to MainWP.

Usage

$sites = apply_filters('mainwp_getgroups', $pluginFile, $childKey, $groupId);

Parameters

$pluginFile
(string) (required) The plugin file is required here, mostly __FILE__
$childKey
(string) (required) The child-key is required here, how to retrieve your child key is explained here
$groupId
(integer) (optional) The id of the group you wish to retrieve

Return Values
(array)
An array that contains an array per group with the following keys: id, name, websites, where websites is an array of website ids.

Usage Examples

Display information about the groups:

$groups = apply_filters( 'mainwp_getgroups', __FILE__, $childKey );
foreach ($groups as $group) {
  echo $group['name'] . ' contains ' . count( $group['websites'] ) . ' child sites<br />';
}

Display the information of a the child-sites in a specific group (uses mainwp-getsites):

$id = 3;
$groups = apply_filters( 'mainwp_getgroups', __FILE__, $childKey, $id );
if ( count( $groups ) == 0 ) {
  echo 'No group with id '. $id . ' found';
}
else {
  echo 'Sites in group ' . $groups[0]['name'];
  foreach ( $groups[0]['websites'] as $siteid ) {
    $sites = apply_filters( 'mainwp_getsites', __FILE__, $childKey, $siteid );
    echo 'Site id: ' . $sites[0]['id'] . '<br />';
    echo 'Site name: ' . $sites[0]['name'] . '<br />';
    echo 'Site url: ' . $sites[0]['url'] . '<br />';
  }
}