Skip to content
  1. Extras
  2. GoogleSheets
  3. Export
  4. Users

Users (modUser)

Standard fields

FieldName
idUser ID
usernameUsername
fullnameFull name
emailEmail
phonePhone
mobilephoneMobile
faxFax
addressAddress
cityCity
stateState / region
zipZIP
countryCountry
websiteWebsite
photoUser photo
dobDate of birth
genderGender
activeActive
blockedBlocked
sudoSudo
blockeduntilBlocked until
blockedafterBlocked after
logincountLogin count
lastloginLast login
failedlogincountFailed login count
createdonUser creation date
primary_groupUser group

Example

Export fields: id,username,email

Table result:

Table result

System events

Class gsUser fires these events:

php
<?php
switch ($modx->event->name) {
  // fetches the list of users
  case 'gsOnBeforeGetUsers':
    // $query - selection query
    // $range - sheet name, where data will be exported
    break;
  case 'gsOnGetUsers':
    // $resources - array of resources with all fields
    // $range - sheet name
    break;
}

Examples

  1. Select users, that belong to group Administrators

    php
    <?php
    if ($modx->event->name == 'gsOnBeforeGetUsers') {
      $query->where(array('primary_group' => 1));
    }
  2. Change field value createdon (user creation date)

    php
    <?php
    if ($modx->event->name == 'gsOnGetUsers') {
      $modx->event->params['users'] = array_map(function($user){
        if (!empty($user['createdon'])) {
          $user['createdon'] = date("d-m-Y",$user['createdon']);
        }
        return $user;
      }, $users);
    }