MODX 2 Object Quick Reference

The following list of MODX Revolution objects is generated from the MODX schema file. Click on one of the links below to jump to the object you want to know about.

Note: If the text background turns blue for you toward the bottom of this page, it's due to a longstanding bug in Firefox. Sometimes turning hardware acceleration off in FF fixes it. If not, try another browser.

This reference is abbreviated for convenience and there's no indication of compound indexes, but it's usually more useful because it shows inherited fields and the Full reference doesn't. Aggregate and composite aliases are combined here (although the aggregates are listed first and there's a little extra space between the aggregate and composite aliases).

To see the MODX 2 object Full Reference, go here.

To see the MODX 3 version of this page, go here.

MODX Revolution Objects

modAccess

   Extends: xPDOSimpleObject
   Fields:
      target  (string)
      principal_class  (string)
      principal  (integer)
      authority  (integer)
      policy  (integer)
   Indexes:   Indexes: target, principal_class, principal, authority, policy

   Aliases:
      Policy
        -- use getOne('Policy') -- returns a modAccessPolicy object
      Principal
        -- use getOne('Principal') -- returns a modPrincipal object
      GroupPrincipal
        -- use getOne('GroupPrincipal') -- returns a modUserGroup object
      UserPrincipal
        -- use getOne('UserPrincipal') -- returns a modUserGroup object
      MinimumRole
        -- use getOne('MinimumRole') -- returns a modUserGroupRole object
Back to Top . . .

modAccessAction

   Extends: modAccess
   Table: modx_access_actions

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess

   Aliases:
      Target
        -- use getOne('Target') -- returns a modAction object
Back to Top . . .

modAccessActionDom

   Extends: modAccess
   Table: modx_access_actiondom

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess

   Aliases:
      Target
        -- use getOne('Target') -- returns a modActionDom object
Back to Top . . .

modAccessCategory

   Extends: modAccess
   Table: modx_access_category

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a modCategory object
      Context
        -- use getOne('Context') -- returns a modContext object
Back to Top . . .

modAccessContext

   Extends: modAccess
   Table: modx_access_context

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess

   Aliases:
      Target
        -- use getOne('Target') -- returns a modContext object
Back to Top . . .

modAccessElement

   Extends: modAccess
   Table: modx_access_elements

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a modElement object
      Context
        -- use getOne('Context') -- returns a modContext object
Back to Top . . .

modAccessMenu

   Extends: modAccess
   Table: modx_access_menus

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess

   Aliases:
      Target
        -- use getOne('Target') -- returns a modMenu object
Back to Top . . .

modAccessNamespace

   Extends: modAccess
   Table: modx_access_namespace

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a modNamespace object
      Context
        -- use getOne('Context') -- returns a modContext object
Back to Top . . .

modAccessPermission

   Extends: xPDOSimpleObject
   Table: modx_access_permissions

   Fields:
      template  (integer)
      name  (string)
      description  (string)
      value  (boolean)
   Indexes:   Indexes: template, name

   Aliases:
      Template
        -- use getOne('Template') -- returns a modAccessPolicyTemplate object
Back to Top . . .

modAccessPolicy

   Extends: xPDOSimpleObject
   Table: modx_access_policies

   Fields:
      name  (string)
      description  (string)
      parent  (integer)
      template  (integer)
      class  (string)
      data  (json)
      lexicon  (string)
   Indexes:   Indexes: name, parent, class, template

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a modAccessPolicy object
      Template
        -- use getOne('Template') -- returns a modAccessPolicyTemplate object

      Children
        -- use getMany('Children') -- returns an array of modAccessPolicy objects
Back to Top . . .

modAccessPolicyTemplate

   Extends: xPDOSimpleObject
   Table: modx_access_policy_templates

   Fields:
      template_group  (integer)
      name  (string)
      description  (string)
      lexicon  (string)

   Aliases:
      TemplateGroup
        -- use getOne('TemplateGroup') -- returns a modAccessPolicyTemplateGroup object

      Permissions
        -- use getMany('Permissions') -- returns an array of modAccessPermission objects
      Policies
        -- use getMany('Policies') -- returns an array of modAccessPolicy objects
Back to Top . . .

modAccessPolicyTemplateGroup

   Extends: xPDOSimpleObject
   Table: modx_access_policy_template_groups

   Fields:
      name  (string)
      description  (string)

   Aliases:

      Templates
        -- use getMany('Templates') -- returns an array of modAccessPolicyTemplate objects
Back to Top . . .

modAccessResource

   Extends: modAccess
   Table: modx_access_resources

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a modResource object
      Context
        -- use getOne('Context') -- returns a modContext object
Back to Top . . .

modAccessResourceGroup

   Extends: modAccess
   Table: modx_access_resource_groups

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key  (string)
   Indexes:   Indexes: context_key, principal_class

   Aliases:
      Target
        -- use getOne('Target') -- returns a modResourceGroup object
      Context
        -- use getOne('Context') -- returns a modContext object
Back to Top . . .

modAccessTemplateVar

   Extends: modAccessElement
   Table: modx_access_templatevars

   Fields:
      target (string) - inherited from modAccess
      principal_class (string) - inherited from modAccess
      principal (integer) - inherited from modAccess
      authority (integer) - inherited from modAccess
      policy (integer) - inherited from modAccess
      context_key (string) - inherited from modAccessElement

   Aliases:
      Target
        -- use getOne('Target') -- returns a modTemplateVar object
Back to Top . . .

modAccessibleObject

   Extends: xPDOObject
Back to Top . . .

modAccessibleSimpleObject

   Extends: modAccessibleObject
   Fields:
      id  (integer)
   Indexes:   Indexes: PRIMARY
Back to Top . . .

modAction

   Extends: modAccessibleSimpleObject
   Table: modx_actions

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      namespace  (string)
      controller  (string)
      haslayout  (integer)
      lang_topics  (string)
      assets  (string)
      help_url  (string)
   Indexes:   Indexes: namespace, controller

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object

      Menus
        -- use getMany('Menus') -- returns an array of modMenu objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessAction objects
      Fields
        -- use getMany('Fields') -- returns an array of modActionField objects
      DOM
        -- use getMany('DOM') -- returns an array of modActionDom objects
Back to Top . . .

modActionDom

   Extends: modAccessibleSimpleObject
   Table: modx_actiondom

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      set  (integer)
      action  (string)
      name  (string)
      description  (string)
      xtype  (string)
      container  (string)
      rule  (string)
      value  (string)
      constraint  (string)
      constraint_field  (string)
      constraint_class  (string)
      active  (boolean)
      for_parent  (boolean)
      rank  (integer)
   Indexes:
        set, action
        name, active
        for_parent, rank
   Aliases:
      FCSet
        -- use getOne('FCSet') -- returns a modFormCustomizationSet object
      Action
        -- use getOne('Action') -- returns a modAction object

      Access
        -- use getMany('Access') -- returns an array of modAccessActionDom objects
Back to Top . . .

modActionField

   Extends: xPDOSimpleObject
   Table: modx_actions_fields

   Fields:
      action  (string)
      name  (string)
      type  (string)
      tab  (string)
      form  (string)
      other  (string)
      rank  (integer)
   Indexes:   Indexes: action, type, tab

   Aliases:
      Action
        -- use getOne('Action') -- returns a modAction object
Back to Top . . .

modActiveUser

   Extends: xPDOObject
   Table: modx_active_users

   Fields:
      internalKey  (integer)
      username  (string)
      lasthit  (timestamp)
      id  (integer)
      action  (string)
      ip  (string)
   Indexes:   Indexes: internalKey

   Aliases:
      User
        -- use getOne('User') -- returns a modUser object
Back to Top . . .

modCategory

   Extends: modAccessibleSimpleObject
   Table: modx_categories

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      parent  (integer)
      category  (string)
      rank  (integer)
   Indexes:   Indexes: parent, category, rank

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a modCategory object
      Chunks
        -- use getMany('Chunks') -- returns an array of modChunk objects
      Snippets
        -- use getMany('Snippets') -- returns an array of modSnippet objects
      Plugins
        -- use getMany('Plugins') -- returns an array of modPlugin objects
      Templates
        -- use getMany('Templates') -- returns an array of modTemplate objects
      TemplateVars
        -- use getMany('TemplateVars') -- returns an array of modTemplateVar objects
      PropertySets
        -- use getMany('PropertySets') -- returns an array of modPropertySet objects

      Children
        -- use getMany('Children') -- returns an array of modCategory objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessCategory objects
      Ancestors
        -- use getMany('Ancestors') -- returns an array of modCategoryClosure objects
      Descendants
        -- use getMany('Descendants') -- returns an array of modCategoryClosure objects
Back to Top . . .

modCategoryClosure

   Extends: xPDOObject
   Table: modx_categories_closure

   Fields:
      ancestor  (integer)
      descendant  (integer)
      depth  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Ancestor
        -- use getOne('Ancestor') -- returns a modCategory object
      Descendant
        -- use getOne('Descendant') -- returns a modCategory object
Back to Top . . .

modChunk

   Extends: modElement
   Table: modx_site_htmlsnippets

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      name  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      cache_type  (integer)
      snippet  (string)
      locked  (boolean)
      properties  (array)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: name, category, locked, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a modCategory object

      PropertySets
        -- use getMany('PropertySets') -- returns an array of modElementPropertySet objects
Back to Top . . .

modClassMap

   Extends: xPDOSimpleObject
   Table: modx_class_map

   Fields:
      class  (string)
      parent_class  (string)
      name_field  (string)
      path  (string)
      lexicon  (string)
   Indexes:   Indexes: class, parent_class, name_field
Back to Top . . .

modContentType

   Extends: xPDOSimpleObject
   Table: modx_content_type

   Fields:
      name  (string)
      description  (string)
      mime_type  (string)
      file_extensions  (string)
      headers  (array)
      binary  (boolean)
   Indexes:   Indexes: name

   Aliases:
      Resources
        -- use getMany('Resources') -- returns an array of modResource objects
Back to Top . . .

modContext

   Extends: modAccessibleObject
   Table: modx_context

   Fields:
      key  (string)
      name  (string)
      description  (string)
      rank  (integer)
   Indexes:   Indexes: PRIMARY, name, rank

   Aliases:

      ContextResources
        -- use getMany('ContextResources') -- returns an array of modContextResource objects
      ContextSettings
        -- use getMany('ContextSettings') -- returns an array of modContextSetting objects
      SourceElements
        -- use getMany('SourceElements') -- returns an array of sources.modMediaSourceElement objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessContext objects
Back to Top . . .

modContextResource

   Extends: xPDOObject
   Table: modx_context_resource

   Fields:
      context_key  (string)
      resource  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Context
        -- use getOne('Context') -- returns a modContext object
      Resource
        -- use getOne('Resource') -- returns a modResource object
Back to Top . . .

modContextSetting

   Extends: xPDOObject
   Table: modx_context_setting

   Fields:
      context_key  (string)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Context
        -- use getOne('Context') -- returns a modContext object
      SystemSetting
        -- use getOne('SystemSetting') -- returns a modSystemSetting object
Back to Top . . .

modDashboard

   Extends: xPDOSimpleObject
   Table: modx_dashboard

   Fields:
      name  (string)
      description  (string)
      hide_trees  (boolean)
   Indexes:   Indexes: name, hide_trees

   Aliases:
      UserGroups
        -- use getMany('UserGroups') -- returns an array of modUserGroup objects

      Placements
        -- use getMany('Placements') -- returns an array of modDashboardWidgetPlacement objects
Back to Top . . .

modDashboardWidget

   Extends: xPDOSimpleObject
   Table: modx_dashboard_widget

   Fields:
      name  (string)
      description  (string)
      type  (string)
      content  (string)
      namespace  (string)
      lexicon  (string)
      size  (string)
   Indexes:   Indexes: name, type, namespace, lexicon

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object

      Placements
        -- use getMany('Placements') -- returns an array of modDashboardWidgetPlacement objects
Back to Top . . .

modDashboardWidgetPlacement

   Extends: xPDOObject
   Table: modx_dashboard_widget_placement

   Fields:
      dashboard  (integer)
      widget  (integer)
      rank  (integer)
   Indexes:   Indexes: PRIMARY, rank

   Aliases:
      Dashboard
        -- use getOne('Dashboard') -- returns a modDashboard object
      Widget
        -- use getOne('Widget') -- returns a modDashboardWidget object
Back to Top . . .

modDocument

   Extends: modResource
   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type (string) - inherited from modResource
      contentType (string) - inherited from modResource
      pagetitle (string) - inherited from modResource
      longtitle (string) - inherited from modResource
      description (string) - inherited from modResource
      alias (string) - inherited from modResource
      alias_visible (boolean) - inherited from modResource
      link_attributes (string) - inherited from modResource
      published (boolean) - inherited from modResource
      pub_date (timestamp) - inherited from modResource
      unpub_date (timestamp) - inherited from modResource
      parent (integer) - inherited from modResource
      isfolder (boolean) - inherited from modResource
      introtext (string) - inherited from modResource
      content (string) - inherited from modResource
      richtext (boolean) - inherited from modResource
      template (integer) - inherited from modResource
      menuindex (integer) - inherited from modResource
      searchable (boolean) - inherited from modResource
      cacheable (boolean) - inherited from modResource
      createdby (integer) - inherited from modResource
      createdon (timestamp) - inherited from modResource
      editedby (integer) - inherited from modResource
      editedon (timestamp) - inherited from modResource
      deleted (boolean) - inherited from modResource
      deletedon (timestamp) - inherited from modResource
      deletedby (integer) - inherited from modResource
      publishedon (timestamp) - inherited from modResource
      publishedby (integer) - inherited from modResource
      menutitle (string) - inherited from modResource
      donthit (boolean) - inherited from modResource
      privateweb (boolean) - inherited from modResource
      privatemgr (boolean) - inherited from modResource
      content_dispo (integer) - inherited from modResource
      hidemenu (boolean) - inherited from modResource
      class_key (string) - inherited from modResource
      context_key (string) - inherited from modResource
      content_type (integer) - inherited from modResource
      uri (string) - inherited from modResource
      uri_override (integer) - inherited from modResource
      hide_children_in_tree (integer) - inherited from modResource
      show_in_tree (integer) - inherited from modResource
      properties (json) - inherited from modResource
Back to Top . . .

modElement

   Extends: modAccessibleSimpleObject
   Table: modx_site_element

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source  (integer)
      property_preprocess  (boolean)

   Aliases:
      CategoryAcls
        -- use getMany('CategoryAcls') -- returns an array of modAccessCategory objects
      Source
        -- use getOne('Source') -- returns a sources.modMediaSource object

      Acls
        -- use getMany('Acls') -- returns an array of modAccessElement objects
Back to Top . . .

modElementPropertySet

   Extends: xPDOObject
   Table: modx_element_property_sets

   Fields:
      element  (integer)
      element_class  (string)
      property_set  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Element
        -- use getOne('Element') -- returns a modElement object
      PropertySet
        -- use getOne('PropertySet') -- returns a modPropertySet object
Back to Top . . .

modEvent

   Extends: xPDOObject
   Table: modx_system_eventnames

   Fields:
      name  (string)
      service  (integer)
      groupname  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:
      PluginEvents
        -- use getMany('PluginEvents') -- returns an array of modPluginEvent objects
Back to Top . . .

modExtensionPackage

   Extends: xPDOSimpleObject
   Table: modx_extension_packages

   Fields:
      namespace  (string)
      name  (string)
      path  (string)
      table_prefix  (string)
      service_class  (string)
      service_name  (string)
      created_at  (datetime)
      updated_at  (datetime)
   Indexes:   Indexes: namespace, name

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object
Back to Top . . .

modFormCustomizationProfile

   Extends: xPDOSimpleObject
   Table: modx_fc_profiles

   Fields:
      name  (string)
      description  (string)
      active  (integer)
      rank  (integer)
   Indexes:   Indexes: name, rank, active

   Aliases:

      Sets
        -- use getMany('Sets') -- returns an array of modFormCustomizationSet objects
      UserGroups
        -- use getMany('UserGroups') -- returns an array of modFormCustomizationProfileUserGroup objects
Back to Top . . .

modFormCustomizationProfileUserGroup

   Extends: xPDOObject
   Table: modx_fc_profiles_usergroups

   Fields:
      usergroup  (integer)
      profile  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      UserGroup
        -- use getOne('UserGroup') -- returns a modUserGroup object
      Profile
        -- use getOne('Profile') -- returns a modFormCustomizationProfile object
Back to Top . . .

modFormCustomizationSet

   Extends: xPDOSimpleObject
   Table: modx_fc_sets

   Fields:
      profile  (integer)
      action  (string)
      description  (string)
      active  (integer)
      template  (integer)
      constraint  (string)
      constraint_field  (string)
      constraint_class  (string)
   Indexes:   Indexes: profile, action, active, template

   Aliases:
      Action
        -- use getOne('Action') -- returns a modAction object
      Template
        -- use getOne('Template') -- returns a modTemplate object
      Profile
        -- use getOne('Profile') -- returns a modFormCustomizationProfile object

      Rules
        -- use getMany('Rules') -- returns an array of modActionDom objects
Back to Top . . .

modJSONRPCResource

   Extends: modXMLRPCResource
Back to Top . . .

modLexiconEntry

   Extends: xPDOSimpleObject
   Table: modx_lexicon_entries

   Fields:
      name  (string)
      value  (string)
      topic  (string)
      namespace  (string)
      language  (string)
      createdon  (datetime)
      editedon  (timestamp)
   Indexes:   Indexes: name, topic, namespace, language

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object
Back to Top . . .

modManagerLog

   Extends: xPDOSimpleObject
   Table: modx_manager_log

   Fields:
      user  (integer)
      occurred  (datetime)
      action  (string)
      classKey  (string)
      item  (string)
   Indexes:   Indexes: user_occurred

   Aliases:
      User
        -- use getOne('User') -- returns a modUser object
Back to Top . . .

modMenu

   Extends: modAccessibleObject
   Table: modx_menus

   Fields:
      text  (string)
      parent  (string)
      action  (string)
      description  (string)
      icon  (string)
      menuindex  (integer)
      params  (string)
      handler  (string)
      permissions  (string)
      namespace  (string)
   Indexes:   Indexes: PRIMARY, parent, action, namespace

   Aliases:
      Action
        -- use getOne('Action') -- returns a modAction object
      Parent
        -- use getOne('Parent') -- returns a modMenu object
      Children
        -- use getMany('Children') -- returns an array of modMenu objects

      Acls
        -- use getMany('Acls') -- returns an array of modAccessMenu objects
Back to Top . . .

modNamespace

   Extends: modAccessibleObject
   Table: modx_namespaces

   Fields:
      name  (string)
      path  (string)
      assets_path  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:

      LexiconEntries
        -- use getMany('LexiconEntries') -- returns an array of modLexiconEntry objects
      SystemSettings
        -- use getMany('SystemSettings') -- returns an array of modSystemSetting objects
      ContextSettings
        -- use getMany('ContextSettings') -- returns an array of modContextSetting objects
      UserSettings
        -- use getMany('UserSettings') -- returns an array of modUserSetting objects
      ExtensionPackages
        -- use getMany('ExtensionPackages') -- returns an array of modExtensionPackage objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessNamespace objects
      Actions
        -- use getMany('Actions') -- returns an array of modAction objects
Back to Top . . .

modPlugin

   Extends: modScript
   Table: modx_site_plugins

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      name (string) - inherited from modScript
      description (string) - inherited from modScript
      editor_type (integer) - inherited from modScript
      category (integer) - inherited from modScript
      cache_type  (integer)
      plugincode  (string)
      locked  (boolean)
      properties  (array)
      disabled  (boolean)
      moduleguid  (string)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: locked, disabled, static

   Aliases:

      PropertySets
        -- use getMany('PropertySets') -- returns an array of modElementPropertySet objects
      PluginEvents
        -- use getMany('PluginEvents') -- returns an array of modPluginEvent objects
Back to Top . . .

modPluginEvent

   Extends: xPDOObject
   Table: modx_site_plugin_events

   Fields:
      pluginid  (integer)
      event  (string)
      priority  (integer)
      propertyset  (integer)
   Indexes:   Indexes: PRIMARY, priority

   Aliases:
      Plugin
        -- use getOne('Plugin') -- returns a modPlugin object
      Event
        -- use getOne('Event') -- returns a modEvent object
      PropertySet
        -- use getOne('PropertySet') -- returns a modPropertySet object
Back to Top . . .

modPrincipal

   Extends: xPDOSimpleObject
   Aliases:

      Acls
        -- use getMany('Acls') -- returns an array of modAccess objects
Back to Top . . .

modPropertySet

   Extends: xPDOSimpleObject
   Table: modx_property_set

   Fields:
      name  (string)
      category  (integer)
      description  (string)
      properties  (array)
   Indexes:   Indexes: name, category

   Aliases:
      Category
        -- use getOne('Category') -- returns a modCategory object

      Elements
        -- use getMany('Elements') -- returns an array of modElementPropertySet objects
Back to Top . . .

modResource

   Extends: modAccessibleSimpleObject
   Table: modx_site_content

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type  (string)
      contentType  (string)
      pagetitle  (string)
      longtitle  (string)
      description  (string)
      alias  (string)
      alias_visible  (boolean)
      link_attributes  (string)
      published  (boolean)
      pub_date  (timestamp)
      unpub_date  (timestamp)
      parent  (integer)
      isfolder  (boolean)
      introtext  (string)
      content  (string)
      richtext  (boolean)
      template  (integer)
      menuindex  (integer)
      searchable  (boolean)
      cacheable  (boolean)
      createdby  (integer)
      createdon  (timestamp)
      editedby  (integer)
      editedon  (timestamp)
      deleted  (boolean)
      deletedon  (timestamp)
      deletedby  (integer)
      publishedon  (timestamp)
      publishedby  (integer)
      menutitle  (string)
      donthit  (boolean)
      privateweb  (boolean)
      privatemgr  (boolean)
      content_dispo  (integer)
      hidemenu  (boolean)
      class_key  (string)
      context_key  (string)
      content_type  (integer)
      uri  (string)
      uri_override  (integer)
      hide_children_in_tree  (integer)
      show_in_tree  (integer)
      properties  (json)
   Indexes:
        alias, published, pub_date, unpub_date
        parent, isfolder, template, menuindex
        searchable, cacheable, hidemenu, class_key
        context_key, uri, uri_override, hide_children_in_tree
        show_in_tree, content_ft_idx, cache_refresh_idx
   Aliases:
      Parent
        -- use getOne('Parent') -- returns a modResource object
      CreatedBy
        -- use getOne('CreatedBy') -- returns a modUser object
      EditedBy
        -- use getOne('EditedBy') -- returns a modUser object
      DeletedBy
        -- use getOne('DeletedBy') -- returns a modUser object
      PublishedBy
        -- use getOne('PublishedBy') -- returns a modUser object
      Template
        -- use getOne('Template') -- returns a modTemplate object
      TemplateVars
        -- use getMany('TemplateVars') -- returns an array of modTemplateVar objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of modTemplateVarTemplate objects
      ContentType
        -- use getOne('ContentType') -- returns a modContentType object
      Context
        -- use getOne('Context') -- returns a modContext object

      Children
        -- use getMany('Children') -- returns an array of modResource objects
      TemplateVarResources
        -- use getMany('TemplateVarResources') -- returns an array of modTemplateVarResource objects
      ResourceGroupResources
        -- use getMany('ResourceGroupResources') -- returns an array of modResourceGroupResource objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessResource objects
      ContextResources
        -- use getMany('ContextResources') -- returns an array of modContextResource objects
Back to Top . . .

modResourceGroup

   Extends: modAccessibleSimpleObject
   Table: modx_documentgroup_names

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      name  (string)
      private_memgroup  (boolean)
      private_webgroup  (boolean)
   Indexes:   Indexes: name

   Aliases:

      ResourceGroupResources
        -- use getMany('ResourceGroupResources') -- returns an array of modResourceGroupResource objects
      TemplateVarResourceGroups
        -- use getMany('TemplateVarResourceGroups') -- returns an array of modTemplateVarResourceGroup objects
      Acls
        -- use getMany('Acls') -- returns an array of modAccessResourceGroup objects
Back to Top . . .

modResourceGroupResource

   Extends: xPDOSimpleObject
   Table: modx_document_groups

   Fields:
      document_group  (integer)
      document  (integer)
   Indexes:   Indexes: document_group, document

   Aliases:
      ResourceGroup
        -- use getOne('ResourceGroup') -- returns a modResourceGroup object
      Resource
        -- use getOne('Resource') -- returns a modResource object
Back to Top . . .

modScript

   Extends: modElement
   Table: modx_site_script

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      name  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
   Indexes:   Indexes: name, category

   Aliases:
      Category
        -- use getOne('Category') -- returns a modCategory object
Back to Top . . .

modSession

   Extends: xPDOObject
   Table: modx_session

   Fields:
      id  (string)
      access  (timestamp)
      data  (string)
   Indexes:   Indexes: PRIMARY, access
Back to Top . . .

modSnippet

   Extends: modScript
   Table: modx_site_snippets

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      name (string) - inherited from modScript
      description (string) - inherited from modScript
      editor_type (integer) - inherited from modScript
      category (integer) - inherited from modScript
      cache_type  (integer)
      snippet  (string)
      locked  (boolean)
      properties  (array)
      moduleguid  (string)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: locked, moduleguid, static

   Aliases:

      PropertySets
        -- use getMany('PropertySets') -- returns an array of modElementPropertySet objects
Back to Top . . .

modStaticResource

   Extends: modResource
   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type (string) - inherited from modResource
      contentType (string) - inherited from modResource
      pagetitle (string) - inherited from modResource
      longtitle (string) - inherited from modResource
      description (string) - inherited from modResource
      alias (string) - inherited from modResource
      alias_visible (boolean) - inherited from modResource
      link_attributes (string) - inherited from modResource
      published (boolean) - inherited from modResource
      pub_date (timestamp) - inherited from modResource
      unpub_date (timestamp) - inherited from modResource
      parent (integer) - inherited from modResource
      isfolder (boolean) - inherited from modResource
      introtext (string) - inherited from modResource
      content (string) - inherited from modResource
      richtext (boolean) - inherited from modResource
      template (integer) - inherited from modResource
      menuindex (integer) - inherited from modResource
      searchable (boolean) - inherited from modResource
      cacheable (boolean) - inherited from modResource
      createdby (integer) - inherited from modResource
      createdon (timestamp) - inherited from modResource
      editedby (integer) - inherited from modResource
      editedon (timestamp) - inherited from modResource
      deleted (boolean) - inherited from modResource
      deletedon (timestamp) - inherited from modResource
      deletedby (integer) - inherited from modResource
      publishedon (timestamp) - inherited from modResource
      publishedby (integer) - inherited from modResource
      menutitle (string) - inherited from modResource
      donthit (boolean) - inherited from modResource
      privateweb (boolean) - inherited from modResource
      privatemgr (boolean) - inherited from modResource
      content_dispo (integer) - inherited from modResource
      hidemenu (boolean) - inherited from modResource
      class_key (string) - inherited from modResource
      context_key (string) - inherited from modResource
      content_type (integer) - inherited from modResource
      uri (string) - inherited from modResource
      uri_override (integer) - inherited from modResource
      hide_children_in_tree (integer) - inherited from modResource
      show_in_tree (integer) - inherited from modResource
      properties (json) - inherited from modResource
Back to Top . . .

modSymLink

   Extends: modResource
   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type (string) - inherited from modResource
      contentType (string) - inherited from modResource
      pagetitle (string) - inherited from modResource
      longtitle (string) - inherited from modResource
      description (string) - inherited from modResource
      alias (string) - inherited from modResource
      alias_visible (boolean) - inherited from modResource
      link_attributes (string) - inherited from modResource
      published (boolean) - inherited from modResource
      pub_date (timestamp) - inherited from modResource
      unpub_date (timestamp) - inherited from modResource
      parent (integer) - inherited from modResource
      isfolder (boolean) - inherited from modResource
      introtext (string) - inherited from modResource
      content (string) - inherited from modResource
      richtext (boolean) - inherited from modResource
      template (integer) - inherited from modResource
      menuindex (integer) - inherited from modResource
      searchable (boolean) - inherited from modResource
      cacheable (boolean) - inherited from modResource
      createdby (integer) - inherited from modResource
      createdon (timestamp) - inherited from modResource
      editedby (integer) - inherited from modResource
      editedon (timestamp) - inherited from modResource
      deleted (boolean) - inherited from modResource
      deletedon (timestamp) - inherited from modResource
      deletedby (integer) - inherited from modResource
      publishedon (timestamp) - inherited from modResource
      publishedby (integer) - inherited from modResource
      menutitle (string) - inherited from modResource
      donthit (boolean) - inherited from modResource
      privateweb (boolean) - inherited from modResource
      privatemgr (boolean) - inherited from modResource
      content_dispo (integer) - inherited from modResource
      hidemenu (boolean) - inherited from modResource
      class_key (string) - inherited from modResource
      context_key (string) - inherited from modResource
      content_type (integer) - inherited from modResource
      uri (string) - inherited from modResource
      uri_override (integer) - inherited from modResource
      hide_children_in_tree (integer) - inherited from modResource
      show_in_tree (integer) - inherited from modResource
      properties (json) - inherited from modResource
Back to Top . . .

modSystemSetting

   Extends: xPDOObject
   Table: modx_system_settings

   Fields:
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      ContextSetting
        -- use getOne('ContextSetting') -- returns a modContextSetting object
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object
Back to Top . . .

modTemplate

   Extends: modElement
   Table: modx_site_templates

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      templatename  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      icon  (string)
      template_type  (integer)
      content  (string)
      locked  (boolean)
      properties  (array)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: templatename, category, locked, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a modCategory object
      Resources
        -- use getMany('Resources') -- returns an array of modResource objects

      PropertySets
        -- use getMany('PropertySets') -- returns an array of modElementPropertySet objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of modTemplateVarTemplate objects
Back to Top . . .

modTemplateVar

   Extends: modElement
   Table: modx_site_tmplvars

   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      source (integer) - inherited from modElement
      property_preprocess (boolean) - inherited from modElement
      type  (string)
      name  (string)
      caption  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      locked  (boolean)
      elements  (string)
      rank  (integer)
      display  (string)
      default_text  (string)
      properties  (array)
      input_properties  (array)
      output_properties  (array)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: name, category, locked, rank, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a modCategory object

      PropertySets
        -- use getMany('PropertySets') -- returns an array of modElementPropertySet objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of modTemplateVarTemplate objects
      TemplateVarResources
        -- use getMany('TemplateVarResources') -- returns an array of modTemplateVarResource objects
      TemplateVarResourceGroups
        -- use getMany('TemplateVarResourceGroups') -- returns an array of modTemplateVarResourceGroup objects
Back to Top . . .

modTemplateVarResource

   Extends: xPDOSimpleObject
   Table: modx_site_tmplvar_contentvalues

   Fields:
      tmplvarid  (integer)
      contentid  (integer)
      value  (string)
   Indexes:   Indexes: tmplvarid, contentid, tv_cnt

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a modTemplateVar object
      Resource
        -- use getOne('Resource') -- returns a modResource object
Back to Top . . .

modTemplateVarResourceGroup

   Extends: xPDOSimpleObject
   Table: modx_site_tmplvar_access

   Fields:
      tmplvarid  (integer)
      documentgroup  (integer)
   Indexes:   Indexes: tmplvar_template

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a modTemplateVar object
      ResourceGroup
        -- use getOne('ResourceGroup') -- returns a modResourceGroup object
Back to Top . . .

modTemplateVarTemplate

   Extends: xPDOObject
   Table: modx_site_tmplvar_templates

   Fields:
      tmplvarid  (integer)
      templateid  (integer)
      rank  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a modTemplateVar object
      Template
        -- use getOne('Template') -- returns a modTemplate object
Back to Top . . .

modUser

   Extends: modPrincipal
   Table: modx_users

   Fields:
      username  (string)
      password  (string)
      cachepwd  (string)
      class_key  (string)
      active  (boolean)
      remote_key  (string)
      remote_data  (json)
      hash_class  (string)
      salt  (string)
      primary_group  (integer)
      session_stale  (array)
      sudo  (boolean)
      createdon  (timestamp)
   Indexes:   Indexes: username, class_key, remote_key, primary_group

   Aliases:
      CreatedResources
        -- use getMany('CreatedResources') -- returns an array of modResource objects
      EditedResources
        -- use getMany('EditedResources') -- returns an array of modResource objects
      DeletedResources
        -- use getMany('DeletedResources') -- returns an array of modResource objects
      PublishedResources
        -- use getMany('PublishedResources') -- returns an array of modResource objects
      SentMessages
        -- use getMany('SentMessages') -- returns an array of modUserMessage objects
      ReceivedMessages
        -- use getMany('ReceivedMessages') -- returns an array of modUserMessage objects
      PrimaryGroup
        -- use getOne('PrimaryGroup') -- returns a modUserGroup object

      Profile
        -- use getOne('Profile') -- returns amodUserProfile object
      UserSettings
        -- use getMany('UserSettings') -- returns an array of modUserSetting objects
      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of modUserGroupMember objects
      ActiveUsers
        -- use getMany('ActiveUsers') -- returns an array of modActiveUser objects
Back to Top . . .

modUserGroup

   Extends: modPrincipal
   Table: modx_membergroup_names

   Fields:
      name  (string)
      description  (string)
      parent  (integer)
      rank  (integer)
      dashboard  (integer)
   Indexes:   Indexes: name, parent, rank, dashboard

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a modUserGroup object
      Children
        -- use getMany('Children') -- returns an array of modUserGroup objects
      Dashboard
        -- use getOne('Dashboard') -- returns a modDashboard object

      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of modUserGroupMember objects
      FormCustomizationProfiles
        -- use getMany('FormCustomizationProfiles') -- returns an array of modFormCustomizationProfileUserGroup objects
Back to Top . . .

modUserGroupMember

   Extends: xPDOSimpleObject
   Table: modx_member_groups

   Fields:
      user_group  (integer)
      member  (integer)
      role  (integer)
      rank  (integer)
   Indexes:   Indexes: role, rank

   Aliases:
      UserGroupRole
        -- use getOne('UserGroupRole') -- returns a modUserGroupRole object
      UserGroup
        -- use getOne('UserGroup') -- returns a modUserGroup object
      User
        -- use getOne('User') -- returns a modUser object
Back to Top . . .

modUserGroupRole

   Extends: xPDOSimpleObject
   Table: modx_user_group_roles

   Fields:
      name  (string)
      description  (string)
      authority  (integer)
   Indexes:   Indexes: name, authority

   Aliases:
      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of modUserGroupMember objects
Back to Top . . .

modUserGroupSetting

   Extends: xPDOObject
   Table: modx_user_group_settings

   Fields:
      group  (integer)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      UserGroup
        -- use getOne('UserGroup') -- returns a modUserGroup object
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object
Back to Top . . .

modUserMessage

   Extends: xPDOSimpleObject
   Table: modx_user_messages

   Fields:
      type  (string)
      subject  (string)
      message  (string)
      sender  (integer)
      recipient  (integer)
      private  (integer)
      date_sent  (datetime)
      read  (integer)

   Aliases:
      Sender
        -- use getOne('Sender') -- returns a modUser object
      Recipient
        -- use getOne('Recipient') -- returns a modUser object
Back to Top . . .

modUserProfile

   Extends: xPDOSimpleObject
   Table: modx_user_attributes

   Fields:
      internalKey  (integer)
      fullname  (string)
      email  (string)
      phone  (string)
      mobilephone  (string)
      blocked  (boolean)
      blockeduntil  (integer)
      blockedafter  (integer)
      logincount  (integer)
      lastlogin  (integer)
      thislogin  (integer)
      failedlogincount  (integer)
      sessionid  (string)
      dob  (integer)
      gender  (integer)
      address  (string)
      country  (string)
      city  (string)
      state  (string)
      zip  (string)
      fax  (string)
      photo  (string)
      comment  (string)
      website  (string)
      extended  (json)
   Indexes:   Indexes: internalKey

   Aliases:
      User
        -- use getOne('User') -- returns a modUser object
Back to Top . . .

modUserSetting

   Extends: xPDOObject
   Table: modx_user_settings

   Fields:
      user  (integer)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      User
        -- use getOne('User') -- returns a modUser object
      Namespace
        -- use getOne('Namespace') -- returns a modNamespace object
Back to Top . . .

modWebLink

   Extends: modResource
   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type (string) - inherited from modResource
      contentType (string) - inherited from modResource
      pagetitle (string) - inherited from modResource
      longtitle (string) - inherited from modResource
      description (string) - inherited from modResource
      alias (string) - inherited from modResource
      alias_visible (boolean) - inherited from modResource
      link_attributes (string) - inherited from modResource
      published (boolean) - inherited from modResource
      pub_date (timestamp) - inherited from modResource
      unpub_date (timestamp) - inherited from modResource
      parent (integer) - inherited from modResource
      isfolder (boolean) - inherited from modResource
      introtext (string) - inherited from modResource
      content (string) - inherited from modResource
      richtext (boolean) - inherited from modResource
      template (integer) - inherited from modResource
      menuindex (integer) - inherited from modResource
      searchable (boolean) - inherited from modResource
      cacheable (boolean) - inherited from modResource
      createdby (integer) - inherited from modResource
      createdon (timestamp) - inherited from modResource
      editedby (integer) - inherited from modResource
      editedon (timestamp) - inherited from modResource
      deleted (boolean) - inherited from modResource
      deletedon (timestamp) - inherited from modResource
      deletedby (integer) - inherited from modResource
      publishedon (timestamp) - inherited from modResource
      publishedby (integer) - inherited from modResource
      menutitle (string) - inherited from modResource
      donthit (boolean) - inherited from modResource
      privateweb (boolean) - inherited from modResource
      privatemgr (boolean) - inherited from modResource
      content_dispo (integer) - inherited from modResource
      hidemenu (boolean) - inherited from modResource
      class_key (string) - inherited from modResource
      context_key (string) - inherited from modResource
      content_type (integer) - inherited from modResource
      uri (string) - inherited from modResource
      uri_override (integer) - inherited from modResource
      hide_children_in_tree (integer) - inherited from modResource
      show_in_tree (integer) - inherited from modResource
      properties (json) - inherited from modResource
Back to Top . . .

modWorkspace

   Extends: xPDOSimpleObject
   Table: modx_workspaces

   Fields:
      name  (string)
      path  (string)
      created  (timestamp)
      active  (boolean)
      attributes  (array)
   Indexes:   Indexes: name, path, active

   Aliases:

      Packages
        -- use getMany('Packages') -- returns an array of transport.modTransportPackage objects
Back to Top . . .

modXMLRPCResource

   Extends: modResource
   Fields:
      id (integer) - inherited from modAccessibleSimpleObject
      type (string) - inherited from modResource
      contentType (string) - inherited from modResource
      pagetitle (string) - inherited from modResource
      longtitle (string) - inherited from modResource
      description (string) - inherited from modResource
      alias (string) - inherited from modResource
      alias_visible (boolean) - inherited from modResource
      link_attributes (string) - inherited from modResource
      published (boolean) - inherited from modResource
      pub_date (timestamp) - inherited from modResource
      unpub_date (timestamp) - inherited from modResource
      parent (integer) - inherited from modResource
      isfolder (boolean) - inherited from modResource
      introtext (string) - inherited from modResource
      content (string) - inherited from modResource
      richtext (boolean) - inherited from modResource
      template (integer) - inherited from modResource
      menuindex (integer) - inherited from modResource
      searchable (boolean) - inherited from modResource
      cacheable (boolean) - inherited from modResource
      createdby (integer) - inherited from modResource
      createdon (timestamp) - inherited from modResource
      editedby (integer) - inherited from modResource
      editedon (timestamp) - inherited from modResource
      deleted (boolean) - inherited from modResource
      deletedon (timestamp) - inherited from modResource
      deletedby (integer) - inherited from modResource
      publishedon (timestamp) - inherited from modResource
      publishedby (integer) - inherited from modResource
      menutitle (string) - inherited from modResource
      donthit (boolean) - inherited from modResource
      privateweb (boolean) - inherited from modResource
      privatemgr (boolean) - inherited from modResource
      content_dispo (integer) - inherited from modResource
      hidemenu (boolean) - inherited from modResource
      class_key (string) - inherited from modResource
      context_key (string) - inherited from modResource
      content_type (integer) - inherited from modResource
      uri (string) - inherited from modResource
      uri_override (integer) - inherited from modResource
      hide_children_in_tree (integer) - inherited from modResource
      show_in_tree (integer) - inherited from modResource
      properties (json) - inherited from modResource
Back to Top . . .

 

My book, MODX: The Official Guide - Digital Edition is now available here. The paper version of the book may still be available from Amazon.

If you have the book and would like to download the code, you can find it here.

If you have the book and would like to see the updates and corrections page, you can find it here.

MODX: The Official Guide is 772 pages long and goes far beyond this web site in explaining beginning and advanced MODX techniques. It includes detailed information on:

  • Installing MODX
  • How MODX Works
  • Working with MODX resources and Elements
  • Using Git with MODX
  • Using common MODX add-on components like SPForm, Login, getResources, and FormIt
  • MODX security Permissions
  • Customizing the MODX Manager
  • Using Form Customization
  • Creating Transport Packages
  • MODX and xPDO object methods
  • MODX System Events
  • Using PHP with MODX

Go here for more information about the book.

Thank you for visiting BobsGuides.com

  —  Bob Ray