Understand your extension details

TL;DR / Overview

This reference explains each setting available when configuring an Extension in the Nilead platform. Extensions act as custom content types, and their structure defines how data is stored, linked, and used across your site. Understanding these details ensures clean data management and reliable front-end behavior.

Prerequisites

• Admin or Editor access to your Nilead site

• Basic understanding of your site structure and data relationships

• Access to the CMS > Extensions section

Walkthrough

Extension Name and Path

• Extension Name:

  • Used internally for labeling in the admin interface

  • You can rename it anytime without breaking site functionality

• Extension Path:

  • Critical for URL generation and backend data access

  • Automatically generates singular and plural versions (e.g., /event, /events)

  • Used to construct object listing/detail page URLs

  • Changing the path after publication? Set up 301 redirects to maintain SEO and link integrity. See: URL Redirection Management

📌 Best Practice: Choose short, descriptive, and lowercase paths (e.g., team-member, faq, product).

Extension Fields

Fields define the structure of each content item within an extension. They are not visual elements but data containers that can be linked to visual layouts later.

Supported Field Types:

• Text (single line or multi-line)

• Number

• Image

• File

• Boolean (yes/no toggle)

• Date/Time

• Dropdown / Select

• Reference (link to another extension)

• Rich Text / HTML Editor

• Slug / Path

• JSON or code blocks (advanced)

For each field, you can configure:

• Label: The visible name of the field in the admin form

• Help Text: Shown to collaborators when editing content

• Required Status: Ensure certain data is always filled

• Default Value / Placeholder: Optional content or hint

📌 Warning: Renaming or deleting a field may break existing content or design bindings. If unsure, contact support before making changes.

Reference Fields

Reference fields link one extension to another, enabling reusable and relational content structures.

Example Use Cases:

• A Blog Post references an Author

• A Product references a Brand or Category

• An Event references a Location

Key Behaviors:

• Changes to a referenced item automatically reflect across linked items

• You can create one-to-one or one-to-many relationships

⚠️ Performance Tip:
Avoid overly complex or deeply nested references — they can slow down content rendering and increase the chance of data syncing issues.

Private Extensions

Use the Private option to prevent the automatic generation of front-facing pages.

When to use:

• Nested data structures (e.g., Article Sections, FAQ Answers)

• Backend-only data used for logic or API responses

• Dynamic content injected into other templates without needing a separate page

Marking an extension as private:

• Hides it from automatic routing

• Still allows content referencing in design and logic

• Keeps admin interface cleaner for editors

FAQs

1. What happens if I change the extension path after publishing my site?
You should set up 301 redirects to ensure existing links still work. Check the redirection settings under CMS > Redirects.

2. Can I delete fields after I've used them?
Yes, but deleting fields may break design bindings or filters. Proceed with caution and consider backing up your content.

3. Are private extensions hidden from the CMS interface?
No — private only affects frontend page generation. You can still manage items and use them in references.

4. How many fields or references should I use per extension?
There's no hard limit, but for performance and maintainability, aim for a clean, purposeful structure with minimal nesting.

5. Can I create a field that references multiple extensions?
No, each reference field can link to only one extension. Use multiple fields or restructure your logic if necessary.