getCategorySettings()

Overview

public struct function getCategorySettings(
      required string  category          
    ,          boolean includeDefaults    = true
    ,          boolean globalDefaultsOnly = false
    ,          string  siteId            
    ,          string  tenantId          
)

Returns all the saved settings for a given category. See Editable system settings for a full guide.

Arguments

Name	Type	Required	Description
category	string	Yes	The name of the category whose settings you wish to get
includeDefaults	boolean	No (default=true)	Whether to include default global and injected settings or whether to just return the settings for the current site
globalDefaultsOnly	boolean	No (default=false)	Whether to only include default global and injected settings or whether to include all amalgamated settings
siteId	string	No	Deprecated (use tenantId from now on) - indicates the site for which you'd like to get settings
tenantId	string	No	ID of the tenant for which you'd like to get settings (tenancy object source can be different per category)