README

PlainText drop-in replacement that can be set to disabled, hidden or readonly.

Requirements

This plugin requires Craft CMS 5.0 or later.

What is it?

Incognito Field adds a custom fieldType to Craft CMS called Incognito. Incognito fields work exactly like regular PlainText fields, except that they can be configured to be disabled, readonly or hidden for element edit forms.

A good example use case for Incognito is whenever you need a field that shouldn't be editable via the CP – e.g. if you want to save some data from a feed or external API on your element model.

Incognito Field works both standalone and inside Matrix blocks.

Configuring Incognito Field

Create a new field (or convert an existing Plain Text field) as Incognito Field. Select the rendering mode you want in the Mode setting to make the field hidden, readonly, disabled (or a regular, visible and editable PlainText field). Optionally, override the mode in Mode Override which you can find in the advanced field settings.

Overriding the rendering mode with Twig logic

You can use Twig in the Mode Override setting field to optionally override the rendering mode. A good use case example is to have the field render as an editable PlainText field for admin users, but be hidden, read only or disabled for everyone else.

Mode Override examples

Render as an editable PlainText field if the element is an unsaved draft:

{{ element.getIsUnsavedDraft() ? 'plain' }}

Render as an editable PlainText field for admin users:

{{ currentUser.admin ? 'plain' }}

Render as a visible, read-only field for users in a particular user group:

{{ currentUser.isInGroup('editors') ? 'readonly' }}

Render as an editable PlainText field for users that have edit site permissions for a particular site:

{% set site = craft.app.sites.getSiteByHandle('germany') %}
{{ currentUser.can('editSite:' ~ site.uid) ? 'plain' }}

Disclaimer

Please report any bugs, feature requests or other issues here.

mmikkel / incognito-field

Maintainers

Details