Umbraco 13 Essentials: Step 3 – Customizing and Extending Your CMS

Introduction

Umbraco 13 offers a flexible and extensible platform that allows developers to create customized content management experiences tailored to specific needs. Whether you want to build custom document types, create unique templates, or extend the functionality through APIs and plugins, Umbraco 13 provides the tools to do so. This article will guide you through the process of customizing and extending Umbraco 13, helping you make the most of this powerful CMS.

Creating Custom Document Types and Templates 

Document types and templates are the foundation of content structure in Umbraco. Here’s how to create and customize them:

Creating Custom Document Types

Document types define the structure and fields of your content. To create a custom document type:

1. Navigate to the Settings Section: Go to the “Settings” section in the backoffice. 

2. Create a New Document Type: 

• Right-click on the “Document Types” node and select “Create”. 

• Enter a name for your document type. 

3. Define the Structure: 

• Add groups and properties to define the fields for your content. 

• Use various property editors such as text boxes, rich text editors, media pickers, and custom property editors. 

Creating Templates

Templates define the layout and presentation of your content. To create a custom template:

Using the Umbraco API

The Umbraco API allows developers to interact programmatically with the CMS, enabling advanced customizations and integrations. Here are some common tasks you can accomplish using the API:

Fetching Content

To fetch content programmatically:

1. Inject the IContentService or IPublishedContentQuery service into your controller or service.
2. Use methods like GetById, GetByContentType, or Search to retrieve content nodes.

public class MyService 
{ 
    private readonly IPublishedContentQuery _contentQuery; 
 
    public MyService(IPublishedContentQuery contentQuery) 
    { 
        _contentQuery = contentQuery; 
    } 
 
    public IPublishedContent GetContentById(int id) 
    { 
        return _contentQuery.Content(id); 
    } 
}

Creating and Updating Content

To create or update content programmatically:

1. Inject the IContentService service.
2. Use methods like Create, Save, and Delete to manage content nodes.

public class MyContentService 
{ 
    private readonly IContentService _contentService; 
 
    public MyContentService(IContentService contentService) 
    { 
        _contentService = contentService; 
    } 
 
    public void CreateContent(string name, int parentId, string documentTypeAlias) 
    { 
        var content = _contentService.Create(name, parentId, documentTypeAlias); 
        _contentService.Save(content); 
    } 
}

Building and Integrating Custom Packages and Plugins

Umbraco’s extensibility model allows developers to build custom packages and plugins that can be easily integrated into the CMS. Here’s how to get started:

Creating a Custom Package

1. Set Up a New Project: Create a new .NET class library project.
2. Define Package Manifest: Create a package.manifest file to define the package metadata and components.
3. Implement Custom Functionality: Add custom controllers, property editors, event handlers, or other components as needed.
4. Package and Deploy: Use tools like NuGet or Umbraco’s package manager to package your project and deploy it to your Umbraco site.

Integrating Custom Plugins

Integrating custom plugins involves adding external functionality to Umbraco. This can include third-party services, custom editors, or backend integrations. Follow these steps:

1. Install the Plugin: Use NuGet or the Umbraco package manager to install the plugin. 
2. Configure the Plugin: Follow the plugin’s documentation to configure any required settings. 
3. Use the Plugin: Integrate the plugin’s functionality into your content workflow, templates, or backoffice interface as needed.

Conclusion 

Customizing and extending Umbraco 13 empowers developers to create tailored content management solutions that meet specific business requirements. By creating custom document types and templates, leveraging the Umbraco API, and building or integrating custom packages and plugins, you can enhance the functionality and user experience of your Umbraco site. 

In the final article of this series, we will explore best practices for optimizing performance and security in Umbraco 13. Stay tuned for more insights and tips on mastering Umbraco 13.