This Sprinkle provides a UI for core and custom site settings

Fund package maintenance!
Ko Fi

Installs: 852

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 4

Forks: 2

Open Issues: 2


3.0.0 2020-05-14 01:38 UTC

This package is auto-updated.

Last update: 2023-09-12 05:04:02 UTC


Donate Latest Version UserFrosting Version Software License Build Codecov StyleCI

Configuration Manager sprinkle for UserFrosting 4. Lets you edit UserFrosting configs from the interface.

Help and Contributing

If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the UserFrosting Chat most of the time for direct support.


Edit UserFrosting app/sprinkles.json file and add the following to the require list : "lcharette/uf_configmanager": "^3.0.0". Also add FormGenerator and ConfigManager to the base list. For example:

    "require": {
        "lcharette/uf_configmanager": "^3.0.0"
    "base": [

Run composer update then php bakery bake to install the sprinkle.


The migration will automatically add the update_site_config permission to the Site Administrator role. To give access to the config UI to another user, simply add the update_site_config permission slug to that user role.

Add link to the menu

The configuration UI is bound to the the /settings route. Simply add a link to this route where you want it. The checkAccess make it so it will appear only for users having the appropriate permission. For example, you can add the following to the sidebar menu :

{% if checkAccess('update_site_config') %}
    <a href="{{site.uri.public}}/settings"><i class="fa fa-gears fa-fw"></i> <span>{{ translate("SITE.CONFIG.MANAGER") }}</span></a>
{% endif %}

Adding custom config

Settings are separated by topics in the UI. Each topic is represented by a file, located in schema/config/. Unlike normal schema files, all entries needs to be wrapped inside a config key. A name and desc top-level entry will allow to define the title and description of the topic.

    "name" : "SITE.CONFIG",
    "desc" : "SITE.CONFIG.DESC",

    "config": { ... }

For example, to add an entry for site.title text and site.registration.enabled checkbox option in a "UserFrosting Settings" topic :

    "name" : "SITE.CONFIG",
    "desc" : "SITE.CONFIG.DESC",

    "config": {
        "site.title" : {
            "validators" : {
                "required" : {
                    "message" : "SITE.TITLE.REQUIRED"
            "form" : {
                "type" : "text",
                "label" : "SITE.TITLE",
                "icon" : "fa-comment"
        "site.registration.enabled" : {
            "validators" : {},
            "form" : {
                "type" : "checkbox",
                "label" : "SITE.REGISTRATION.ENABLED"

NOTE Only .json are accepted. Yaml schemas are cannot be used for now.


By Louis Charette. Copyright (c) 2020, free to use in personal and commercial software as per the MIT license.