Sections

    The Umbraco backoffice consists of Sections, also referred to as Applications, which contain Trees.

    Each section is shown in the top navigation ribbon of the Umbraco Backoffice.

    Create a Custom Section

    To create a new custom section in your Umbraco backoffice, the first thing you have to do is create a new folder inside /App_Plugins. We will call it MyFavouriteThings.

    Next we need to create a manifest where we'll include some basic configuration for our new section.

    Registering a Custom Section

    There are two approaches to registering a custom section to appear in the Umbraco Backoffice:

    Registering with package.manifest

    Create a new file in the /App_Plugins/MyFavouriteThings/ folder and name it package.manifest. In this new file, copy the code snippet below and save it.

    {
        "sections": [
            {
                "alias": "myFavouriteThings",
                "name": "My Favourite Things"
            }
        ]
    }

    ... would create a new section in your Umbraco backoffice called 'My Favourite Things'.

    When registering your section this way, it is added to the end of the collection of sections. But as more package.manifest files may do the same, the order of the additional sections depends on the order of which the package.manifest files are loaded. Registering your section this way doesn't allow further control of its order.

    Registering with C# Type

    By creating a C# class that implements ISection from Umbraco.Core.Models.Sections:

    using Umbraco.Core.Models.Sections;
    
    namespace My.Website.Sections
    {
        public class MyFavouriteThingsSection : ISection
        {
            /// <inheritdoc />
            public string Alias => "myFavouriteThings";
    
            /// <inheritdoc />
            public string Name => "My Favourite Things";
        }
    }
    

    For your C# type to be discovered by Umbraco at application start up, it needs to be appended to the SectionCollectionBuilder using a C# class which implements IUserComposer.

    using My.Website.Sections;
    using Umbraco.Core.Composing;
    using Umbraco.Web;
    
    namespace My.Website.Composers
    {
        public class SectionComposer : IUserComposer
        {
            /// <summary>Compose.</summary>
            public void Compose(Composition composition)
            {
                composition.Sections().Append<MyFavouriteThingsSection>();
            }
        }
    }
    

    This would also create a new section called 'My Favourite Things' in your Umbraco Backoffice.

    Similar to registering the section via a package.manifest file, the Append<> method will add the section to the end of the list of sections.

    If you wish to control the order of your section a bit more, you can use some of the other methods on SectionsCollectionBuilder. For instance, you can add your section at a specific index:

    composition.Sections().Insert<MyFavouriteThingsSection>(2);
    

    Or before or after an existing section:

    composition.Sections().InsertBefore<SettingsSection, MyFavouriteThingsSection>();
    
    composition.Sections().InsertAfter<SettingsSection, MyFavouriteThingsSection>();
    

    The final order of the sections is down to the order of which the composers are executed. For instance, two composers may add a new section before SettingsSection, in which case the latter will add it's section between the section of the first composer and SettingsSection.

    Why can't I see my new Custom Section?

    You will also need to allow your current Umbraco User group access to this new Custom Section via the backoffice! (you will need to logout and back in again to see the change)

    Add Section for User

    Adding a Language Translation (get rid of the square brackets)

    Custom Section appears displaying Alias

    When your new custom section appears, you'll notice only the section 'Alias' is displayed inside square brackets. This is because Umbraco caters for Multiple Languages in the backoffice, and is looking for a translation file for the current backoffice culture, containing a translation key for your custom section alias.

    Create a /lang folder in the folder where you are creating the implementation for your custom section. If not create one in the App_Plugins folder eg. /App_Plugins/MyFavouriteThings/lang/.

    It is worth knowing that the /lang folder does not have to be directly in the MyFavouriteThings folder, it can be nested deeper if you need it to be. The only requirement is that the folder is called lang. E.g. ~/App_Plugins/MyFavouriteThings/Some/Another/Lang/.

    Inside this folder create a file called en-us.xml. This is the 'default' fallback language translation file. Add the following definition:

    <?xml version="1.0" encoding="utf-8" standalone="yes"?>
    <language alias="en" intName="English (US)" localName="English (US)" lcid="" culture="en-US">
      <area alias="sections">
        <key alias="myFavouriteThings">My Favourite Things</key>
      </area>
    </language>
    

    Recycle the application pool, and the square brackets will be gone, and your section will have the title 'My Favourite Things'

    You can add custom language translation keys in this file for providing translated versions of text used throughout your custom section/tree implementation.

    To provide translations in other languages, duplicate the en-us.xml file in the /lang folder and rename it to match the lang/culture combination of your newly supported language. Update the contents of the language element attributes, and provide a translation for each 'language translation key'.

    You will need to recycle the application pool, to see changes to the language translation files reflected in the backoffice.

    Now create a custom tree to load in your custom section!

    Section Service API v7

    The section API in v7+ is found in the interface Umbraco.Core.Services.ISectionService which is exposed on the ApplicationContext singleton. This API is used to control/query the storage for tree registrations in the ~/Config/applications.config file.

    See the section service API reference here

    Section (Application) API v6

    The section API in v6/v4 is found in the class umbraco.BusinessLogic.Application. This API is used to control/query the storage for section registrations in the ~/Config/applications.config file.