Системные настройки

Последнее обновление Oct 22nd, 2026 | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

Системные настройки действуют на весь сайт. Редактируйте их в разделе «Система» → «Системные настройки». В шаблонах значение доступно как [[++key]], в PHP — через $modx->getOption('key').

Переопределение настроек (наследование)¶

Настройку можно переопределить на четырёх уровнях. Для вошедшего пользователя MODX проверяет их в таком порядке:

Настройка пользователя
Настройка группы пользователей
Настройка контекста (в менеджере обычно mgr)
Системная настройка

Создание системной настройки в менеджере¶

Откройте «Система» → «Системные настройки» и нажмите «Создать».

Параметры¶

Поле	Назначение
Ключ	Уникальное имя для `[[++key]]` и `getOption()`.
Имя	Подпись в списке настроек; может быть локализована.
Тип поля	xtype поля; см. Типы системных настроек.
Пространство имён	Папка внутри `core/components/`, как у пользовательских страниц менеджера.
Area Lexicon Entry	Группирует настройки с одинаковым значением.
Значение	Значение по умолчанию.
Описание	Подсказка; может быть локализована.

Локализация¶

Имя и описание берутся из записей лексикона:

Имя: setting_ + ключ
Описание: setting_ + ключ + _desc

В пакете эти записи лежат в core/components/<namespace>/lexicon/<language>/default.inc.php:

$_lang['setting_quip.emailsFrom'] = 'From Email';
$_lang['setting_quip.emailsFrom_desc'] = 'The email address to send system emails from.';

Чтение настройки в коде¶

Передайте ключ настройки в getOption():

$siteStartId = $modx->getOption('site_start');

getOption() читает кэш настроек, а не базу данных.

Сохранение настройки в коде¶

Значение из getOption() кэшируется и доступно только для чтения. Чтобы изменить настройку, загрузите объект modSystemSetting, обновите его, сохраните и очистите кэш.

Обновление объекта¶

use MODX\Revolution\modSystemSetting;

$setting = $modx->getObject(modSystemSetting::class, 'site_name');
if ($setting) {
    $setting->set('value', 'My New Site Name');
    $setting->save();
}

Очистка кэша¶

Сохранение не обновляет кэш настроек. Очистите system_settings; добавьте resource, если значение используется на сайте:

$modx->cacheManager->refresh([
    'system_settings' => [],
    'resource' => [],
]);

Метаданные настройки¶

use MODX\Revolution\modSystemSetting;

$setting = $modx->getObject(modSystemSetting::class, 'site_name');
print_r($setting->toArray());

Список связанных настроек¶

Группируйте настройки по area или по префиксу ключа.

По области¶

use MODX\Revolution\modSystemSetting;

$relatedSettings = $modx->getCollection(modSystemSetting::class, ['area' => 'mail']);
foreach ($relatedSettings as $setting) {
    print $setting->get('value');
}

По префиксу ключа¶

use MODX\Revolution\modSystemSetting;

$query = $modx->newQuery(modSystemSetting::class);
$query->where(['key:LIKE' => 'quip.%']);
$relatedSettings = $modx->getCollection(modSystemSetting::class, $query);
foreach ($relatedSettings as $setting) {
    print $setting->get('value');
}

Создание настройки в коде¶

use MODX\Revolution\modSystemSetting;

$setting = $modx->newObject(modSystemSetting::class);
$setting->set('key', 'mykey');
$setting->set('value', 'my_value');
$setting->set('xtype', 'textfield');
$setting->set('namespace', 'my_namespace');
$setting->set('area', 'MyArea');
$setting->save();

$modx->cacheManager->refresh(['system_settings' => []]);

Добавьте записи лексикона, чтобы у настройки появились имя и описание:

$_lang['setting_mykey'] = 'Name of My Setting';
$_lang['setting_mykey_desc'] = 'Description of my key';

Чтобы вывести подпись настройки в шаблоне или пользовательской странице менеджера, вызовите тег лексикона с темой setting:

[[!%setting_emailsender? &topic=`setting` &namespace=`core` &language=`en`]]

Типы системных настроек¶

Атрибут xtype задаёт поле, которое используется в менеджере:

xtype	Поле
`combo-boolean`	Да/Нет; хранит `1` или `0`
`textfield`	Однострочный текст
`textarea`	Многострочный текст
`text-password`	Скрытый текст
`numberfield`	Число
`modx-combo-language`	Выбор языка
`modx-combo-source`	Выбор источника медиа
`modx-combo-template`	Выбор шаблона
`modx-combo-content-type`	Выбор типа содержимого
`modx-combo-charset`	Выбор кодировки
`modx-combo-rte`	Выбор визуального редактора
`modx-combo-context`	Выбор контекста
`modx-combo-namespace`	Выбор пространства имён
`modx-combo-manager-theme`	Выбор темы менеджера

Список настроек¶