Creating custom template tags in Django

custom template tags in django

Sometimes existing templates tags are not enough for rebellious developers. They need to create custom template tags to use. In this article we are discussing step by step process to create and use custom template tags in django.

Template Tags:

If all the tags are related to app then bundle them inside that app, otherwise you may create a new app and then add newly created app to INSTALLED_APPS.

Steps to create custom template tags:

  • Create a new directory inside your app and name it ‘templatetags’.
  • Create __init__.py  file inside this newly created directory.
  • Create tags file. Lets name is custom_template_tag.py
  • Import template.
  • All the tags should be registered to template.library  instance.
  • For registering tags, create a module level variable, lets name it library . So on the top of file , after import statements write
    register = template.library() 

    .

  • Now lets create a very simple tag to get random number in template. For this you need to import randint .
  • write code to generate random number and register that function with library. Complete code should look like below.

 

How to use custom tag in django templates:

Now when we have created custom tag and registered it with library, we can use it in templates.

Load the tag class in your template before using any template.

{% load custom_template_tags %}

now use custom tag any where in your html. {% random_number %} . This will print a random number at the same place. you can store the output of tag in some variable can can use to anywhere in template.

{% random_number as rnd %} now any where in template use {{rnd}} .

Things to take care of to make custom tags work:
  • Make sure you restarted the development server.
  • Directory name must be templatetags .
  • __init__.py  must be present in directory.
  • App where templatetags  directory is created must be present in installed apps.
  • Load the tag file in the template file where tag will be used. Loading file in parent template and then expecting it would be available to all child templates, would not work. Because zen of python.
  • If tag still not working, remove all .pyc  files.

 

If it is still not working for you, please comment.

(Visited 209 times, 1 visits today)

Leave a Reply

Your email address will not be published. Required fields are marked *