How To Create Custom Context Processors in Django

2 min read

Django provides a convenient way to add extra data to the context of a template through context processors. These context processors can be used to display information such as the current user, site-wide settings, or even data that is fetched from the database.

With a few lines of code, you can create your own custom context processors and make them available to all of your templates.

In this article, we will show you how to create custom context processors in Django, and how to use them in your templates.

Before we start, it's important to note that context processors are only available to templates that use the RequestContext context. If you're using the default django.template.context_processors.request context processor, then you're already using RequestContext.

Creating a Custom Context Processor

To create a custom context processor, you first need to create a new file in your app folder. This file can be named anything you like, for example

In the new file, create a function that will return the data you want to add to the context. The function should take one parameter, the request object, and should return a dictionary containing the data.

For example:

def site_settings(request):
    return {'site_name': 'My awesome site', 'site_creation_date': '12/12/12'}

This context processor will add two variables to the context, site_name and site_creation_date, with the values 'My awesome site' and '12/12/12', respectively.

Using the Custom Context Processor

To use the custom context processor, you need to add the name of the function to the context_processors option in the TEMPLATES setting in your file.

        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'yourapp.context_processors.site_settings'  # <-- our custom context processor

Note that you have to provide the full path of the file. Now, in any template that extends a template that uses the RequestContext context processor, the site_name and site_creation_date variables will be available to use.

For example, in your base.html template, you can use the variables as follows:

    <title>{{ site_name }}</title>
        <p>Created at; {{ site_creation_date }}</p>

As you can see, the context processor makes it easy to add variables that can be used across multiple templates without having to pass them through the view or template.

Latest Articles

Latest from djangocentral

Capturing Query Parameters of request.get in Django

In Django, the request object contains a variety of information about the current HTTP request, including the query parameters. Query parameters are a way to pass additional information in the URL and are used to filter or sort data. The request object p…
Read more →

2 min read

Understanding related_name in Django Models

In Django, related_name is an attribute that can be used to specify the name of the reverse relation from the related model back to the model that defines the relation. It is used to specify the name of the attribute that will be used to access the relat…
Read more →

2 min read