PolyCMS
Back to Main Site

Hook: settings.defaults

Last updated on May 21, 2026 00:42

Overview

Type: Filter Location: app/Services/SettingsService.php

Extends or overrides default setting definitions. Themes and modules use this to register their own settings that appear in the admin Settings page.

Parameters

Param Type Description
$defaults array All default setting groups
$settingsService SettingsService Service instance

Return

Must return array - extended defaults.

Usage Example

Hook::addFilter('settings.defaults', function (array $defaults) {
    $defaults['mymodule'] = [
        'mymodule_api_key' => [
            'key' => 'mymodule_api_key',
            'value' => '',
            'type' => 'text',
            'label' => 'API Key',
        ],
    ];
    return $defaults;
});

Related Hooks