Create a template filter to linkify objects #6231

New Issue

adam · 2025-12-29T19:38:18+01:00

adam commented

2025-12-29 19:38:18 +01:00

Originally created by @jeremystretch on GitHub (Mar 18, 2022).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Introduce a linkify template filter that will render a link to an object. For example,

{{ object|linkify }}

would be equivalent to

<a href="{{ object.get_absolute_url }}">{{ object }}</a>

If object does not have a get_absolute_url() method, the filter returns the string representation of object, or None.

Justification

There's a common pattern in templates where we want to link to an object as its string representation. For example:

<a href="{{ object.attr.get_absolute_url }}">{{ object.attr }}</a>

While this isn't terribly obtuse, it can get a bit ugly when we introduce a conditional:

{% if object.attr %}
    <a href="{{ object.attr.get_absolute_url }}">{{ object.attr }}</a>
{% else %}
    {{ ''|placeholder }}
{% endif %}

With a linkify filter in place, we could just do:

{{ object.attr|linkify|placeholder }}

Originally created by @jeremystretch on GitHub (Mar 18, 2022). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Introduce a `linkify` template filter that will render a link to an object. For example, ``` {{ object|linkify }} ``` would be equivalent to ``` <a href="{{ object.get_absolute_url }}">{{ object }}</a> ``` If `object` does not have a `get_absolute_url()` method, the filter returns the string representation of `object`, or None. ### Justification There's a common pattern in templates where we want to link to an object as its string representation. For example: ``` <a href="{{ object.attr.get_absolute_url }}">{{ object.attr }}</a> ``` While this isn't terribly obtuse, it can get a bit ugly when we introduce a conditional: ``` {% if object.attr %} <a href="{{ object.attr.get_absolute_url }}">{{ object.attr }}</a> {% else %} {{ ''|placeholder }} {% endif %} ``` With a `linkify` filter in place, we could just do: ``` {{ object.attr|linkify|placeholder }} ```

adam added the status: accepted type: housekeeping labels 2025-12-29 19:38:18 +01:00

adam closed this issue

2025-12-29 19:38:19 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#6231