ModelAdminLien vers cette rubrique#Les classes ModelAdmin peuvent définir des filtres de listes apparaissant dans la barre de droite de la page de liste pour modification de l’administration, comme illustré dans la capture d’écran suivante :
![\"/fr/4.1/_images/list_filter.png\"](\"/fr/4.1/_images/list_filter.png\")
\nPour activer le filtrage par champ, définissez ModelAdmin.list_filter à une liste ou un tuple d’éléments, où le type de chaque élément est l’un des suivants :
Un nom de champ.
Une sous-classe de django.contrib.admin.SimpleListFilter.
Un tuple binaire contenant un nom de champ et une sous-classe de django.contrib.admin.FieldListFilter.
Consultez les exemples ci-dessous pour une discussion de chacune de ces options pour définir list_filter.
L’option la plus simple est de définir les noms de champ requis d’après votre modèle.
\nChaque champ indiqué doit être soit un BooleanField, CharField, DateField, DateTimeField, IntegerField, ForeignKey ou un ManyToManyField; par exemple :
class PersonAdmin(admin.ModelAdmin):\n list_filter = ('is_staff', 'company')\nLes noms de champ dans list_filter peuvent également s’étendre aux relations à l’aide de la syntaxe de recherche __, par exemple :
class PersonAdmin(admin.UserAdmin):\n list_filter = ('company__name',)\nSimpleListFilterLien vers cette rubrique#Pour un filtrage personnalisé, vous pouvez définir votre propre filtre de liste en créant une sous-classe de django.contrib.admin.SimpleListFilter. Celle-ci devra contenir les attributs title et parameter_name ainsi que surcharger les méthodes lookups et queryset, par ex. :
from datetime import date\n\nfrom django.contrib import admin\nfrom django.utils.translation import gettext_lazy as _\n\nclass DecadeBornListFilter(admin.SimpleListFilter):\n # Human-readable title which will be displayed in the\n # right admin sidebar just above the filter options.\n title = _('decade born')\n\n # Parameter for the filter that will be used in the URL query.\n parameter_name = 'decade'\n\n def lookups(self, request, model_admin):\n """\n Returns a list of tuples. The first element in each\n tuple is the coded value for the option that will\n appear in the URL query. The second element is the\n human-readable name for the option that will appear\n in the right sidebar.\n """\n return (\n ('80s', _('in the eighties')),\n ('90s', _('in the nineties')),\n )\n\n def queryset(self, request, queryset):\n """\n Returns the filtered queryset based on the value\n provided in the query string and retrievable via\n `self.value()`.\n """\n # Compare the requested value (either '80s' or '90s')\n # to decide how to filter the queryset.\n if self.value() == '80s':\n return queryset.filter(\n birthday__gte=date(1980, 1, 1),\n birthday__lte=date(1989, 12, 31),\n )\n if self.value() == '90s':\n return queryset.filter(\n birthday__gte=date(1990, 1, 1),\n birthday__lte=date(1999, 12, 31),\n )\n\nclass PersonAdmin(admin.ModelAdmin):\n list_filter = (DecadeBornListFilter,)\nFieldListFilter expliciteLien vers cette rubrique#Pour terminer, si vous souhaitez indiquer explicitement un type de filtre à utiliser pour un champ, vous pouvez indiquer un élément list_filter sous forme de tuple binaire, où le première élément est un nom de champ et le second une classe héritant de django.contrib.admin.FieldListFilter, par exemple
class PersonAdmin(admin.ModelAdmin):\n list_filter = (\n ('is_staff', admin.BooleanFieldListFilter),\n )\nIci, le champ is_staff utilisera le filtre BooleanFieldListFilter. En indiquant uniquement le nom du champ, le filtre approprié sera sélectionné dans la plupart des cas, mais ce format vous permet de contrôler le filtre qui sera choisi.
Les exemples suivants montrent les classes de filtre disponibles qu’il faut indiquer explicitement si on veut les utiliser.
\nVous pouvez limiter les choix d’un modèle lié aux objets concernés par la relation en utilisant RelatedOnlyFieldListFilter:
class BookAdmin(admin.ModelAdmin):\n list_filter = (\n ('author', admin.RelatedOnlyFieldListFilter),\n )\nEn supposant que author est une clé ForeignKey vers un modèle User, cela va limiter les choix de list_filter aux utilisateurs qui ont écrit un livre, au lieu d’énumérer tous les utilisateurs.
Vous pouvez filtrer les valeurs vides avec EmptyFieldListFilter, qui est capable de filtrer à la fois les chaînes vides et les valeurs nulles, en fonction de ce que le champ permet de stocker
class BookAdmin(admin.ModelAdmin):\n list_filter = (\n ('title', admin.EmptyFieldListFilter),\n )\nEn définissant un filtre par l’expression __in, il est possible de filtrer par n’importe quel groupe de valeurs. Vous devez surcharger la méthode expected_parameters et indiquer l’attribut lookup_kwargs avec le nom de champ approprié. Par défaut, des valeurs multiples dans la chaîne de requête seront séparées par des virgules, mais cela peut être modifié par l’attribut list_separator. L’exemple suivant montre un tel filtre utilisant le caractère barre verticale comme séparateur
class FilterWithCustomSeparator(admin.FieldListFilter):\n # custom list separator that should be used to separate values.\n list_separator = '|'\n\n def __init__(self, field, request, params, model, model_admin, field_path):\n self.lookup_kwarg = '%s__in' % field_path\n super().__init__(field, request, params, model, model_admin, field_path)\n\n def expected_parameters(self):\n return [self.lookup_kwarg]\nLes filtres de listes n’apparaissent que lorsque le filtre présente plus d’un choix. La méthode has_output() du filtre vérifie cette condition.
Il est possible de spécifier un gabarit personnalisé pour le rendu d’un filtre de liste :
\nclass FilterWithCustomTemplate(admin.SimpleListFilter):\n template = "custom_template.html"\nVoir le gabarit par défaut fourni par Django (admin/filter.html) pour un exemple concret.