Django Admin linking to related objects

Solution 1:

Modifying your model isn't necessary, and it's actually a bad practice (adding admin-specific view-logic into your models? Yuck!) It may not even be possible in some scenarios.

Luckily, it can all be achieved from the ModelAdmin class:

from django.urls import reverse
from django.utils.safestring import mark_safe    


class PageAdmin(admin.ModelAdmin):
    # Add it to the list view:
    list_display = ('name', 'user_link', )
    # Add it to the details view:
    readonly_fields = ('user_link',)

    def user_link(self, obj):
        return mark_safe('<a href="{}">{}</a>'.format(
            reverse("admin:auth_user_change", args=(obj.user.pk,)),
            obj.user.email
        ))
    user_link.short_description = 'user'


admin.site.register(Page, PageAdmin)

Edit 2016-01-17: Updated answer to use make_safe, since allow_tags is now deprecated.

Edit 2019-06-14: Updated answer to use django.urls, since as of Django 1.10 django.core.urls has been deprecated.

Solution 2:

Add this to your model:

  def user_link(self):
      return '<a href="%s">%s</a>' % (reverse("admin:auth_user_change", args=(self.user.id,)) , escape(self.user))

  user_link.allow_tags = True
  user_link.short_description = "User" 

You might also need to add the following to the top of models.py:

  from django.template.defaultfilters import escape
  from django.core.urls import reverse

In admin.py, in list_display, add user_link:

list_display = ('name', 'user_link', )

No need for list_display_links.

Solution 3:

You need to use format_html for modern versions od django

@admin.register(models.Foo)
class FooAdmin(admin.ModelAdmin):
    list_display = ('ts', 'bar_link',)

    def bar_link(self, item):
        from django.shortcuts import resolve_url
        from django.contrib.admin.templatetags.admin_urls import admin_urlname
        url = resolve_url(admin_urlname(models.Bar._meta, 'change'), item.bar.id)
        return format_html('<a href="{url}">{name}</a>'.format(url=url, name=str(item.bar)))

Solution 4:

I ended up with a simple helper:

from django.shortcuts import resolve_url
from django.utils.safestring import SafeText
from django.contrib.admin.templatetags.admin_urls import admin_urlname
from django.utils.html import format_html


def model_admin_url(obj: Model, name: str = None) -> str:
    url = resolve_url(admin_urlname(obj._meta, SafeText("change")), obj.pk)
    return format_html('<a href="{}">{}</a>', url, name or str(obj))

Then you can use the helper in your model-admin:

class MyAdmin(admin.ModelAdmin):
    readonly_field = ["my_link"]

    def my_link(self, obj):
        return model_admin_url(obj.my_foreign_key)

Solution 5:

I needed this for a lot of my admin pages, so I created a mixin for it that handles different use cases:

pip install django-admin-relation-links

Then:

from django.contrib import admin
from django_admin_relation_links import AdminChangeLinksMixin


@admin.register(Group)
class MyModelAdmin(AdminChangeLinksMixin, admin.ModelAdmin):

    # ...

    change_links = ['field_name']

See the GitHub page for more info. Try it out and let me know how it works out!

https://github.com/gitaarik/django-admin-relation-links