Class ExtensionData

Checks whether a given extension has registered permissions.

This function simply takes the extension id

Example

app.extensionData.for('flarum-tags')

flarum/flags -> flarum-flags | acme/extension -> acme-extension
Copy

Get an ItemList of all extensions' registered permissions

Get a singular extension's registered permissions

Returns an extension's custom page component if it exists.

Get an extension's registered settings

Replace the default extension page with a custom component. This component would typically extend ExtensionPage

This function registers your permission with Flarum

Example

.registerPermission('permissions', {
    icon: 'fas fa-flag',
    label: app.translator.trans('flarum-flags.admin.permissions.view_flags_label'),
    permission: 'discussion.viewFlags'
}, 'moderate', 65)
Copy

This function registers your settings with Flarum

It takes either a settings object or a callback.

Example

.registerSetting({
  setting: 'flarum-flags.guidelines_url',
  type: 'text', // This will be inputted into the input tag for the setting (text/number/etc)
  label: app.translator.trans('flarum-flags.admin.settings.guidelines_url_label')
}, 15) // priority is optional (ItemList)
Copy