Support Our Site

To ensure we can continue delivering content and maintaining a free platform for all users, we kindly request that you disable your adblocker. Your contribution greatly supports our site's growth and development.

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

How to Use Subquery() in Django With Practical Examples

In the realm of web development, Django stands as a powerful and versatile framework for building robust applications. One of the key aspects of developing efficient and optimized web applications is handling database queries effectively. In this article…
Read more →

4 min read

DRF Serializer: Handling OrderedDict and Converting It to a Dictionary or JSON

In Django Rest Framework (DRF) tests, when you access, you might encounter an OrderedDict instead of a regular dictionary. This behavior is intentional and reflects the design of DRF's serialization process.Understanding the Problem The u…
Read more →

3 min read

Django Rest Framework CheetSheet: Mastering API Development

Django Rest Framework (DRF) is a powerful toolkit that makes building robust and scalable web APIs with Django a breeze. Whether you're a seasoned Django developer or a newcomer, having a comprehensive cheat sheet at your disposal can be a game-changer. …
Read more →

5 min read

How to Perform NOT Queries in Django ORM

In Django, performing NOT queries allows you to exclude certain records from the query results based on specific conditions. The NOT operator, represented by the tilde (~) when used in conjunction with the Django ORM's Q object, helps you construct compl…
Read more →

3 min read