Django Regroup Template Tag
Transform Your Career
Choose from our industry-leading programs designed for career success
Modern Software and AI Engineering Program
Master full-stack development with AI integration
+1000 moreModern Data Science and ML with specialisation in AI
Advanced data science techniques with AI specialization
+1000 moreAdvanced AIML with Specialisation in Agentic AI
Deep dive into AIML with focus on Agentic systems
+1000 moreDevOps, Cloud & AI Platform Engineering
Build and manage AI-powered cloud infrastructure
+1000 moreAI Engineering Advanced Certification by IIT-Roorkee
Premier AI engineering certification from IIT-Roorkee
Overview
Django regroup template tag is used for grouping of the objects list by a particular attribute and then in our template we can iterate over that group.
Definition and Usage
Objects from the existing list are grouped by the Django regroup tag and we can further iterate over those grouped objects.
Let us take an example of a list of students and every student has a class and name attribute. Now we want these students will be grouped by their class and then we can display grouped students in our template.
Now in our template student_list.html, we will Django regroup template tag for grouping students by class.
In this example, {% regroup %} is used to group the students by the class attribute and assign the result to class_list. Then, we iterate over class_list, and for every group, we use {{ class.grouper }} for displaying the class name and using another loop for listing the students in that class. So we will get the following output
Students by Class
I
- Steve
- Shiang
- Jhanvi
II
- Mrinal
- Risha
Scaler Placement Report and Statistics
Scaler learners achieved 2.5x salary growth with average post-Scaler CTC reaching ₹23L.
Google
Amazon
Microsoft
Flipkart
Adobe1200+ moreSyntax
The syntax of the Django regroup tag is given below:
Parameters
| Parameter name | Description |
|---|---|
| object | Required. An object or list on which you want to perform regrouping. |
| object.property | Required. Specify the property name that you want to group by. |
| newname | Required. A new name you want to give to the returned object as per your requirements. |
Turn Learning into Career Growth
Conclusion
- Django regroup template tag is used for grouping the objects list by a particular attribute and then in our template, we can iterate over that group.
- {% regroup object by object.property as newname %} is a syntax of django regroup template.
