diff --git a/src/pretix/base/signals.py b/src/pretix/base/signals.py index ff910b45f..11850876d 100644 --- a/src/pretix/base/signals.py +++ b/src/pretix/base/signals.py @@ -637,41 +637,16 @@ logentry_display = EventPluginSignal() """ Arguments: ``logentry`` -To display an instance of the ``LogEntry`` model to a human user, -``pretix.base.signals.logentry_display`` will be sent out with a ``logentry`` argument. - -The first received response that is not ``None`` will be used to display the log entry -to the user. The receivers are expected to return plain text. - -As with all event-plugin signals, the ``sender`` keyword argument will contain the event. +**DEPRECTATION:** Please do not use this signal for new LogEntry types. Use the log_entry_types +registry instead, as described in https://docs.pretix.eu/en/latest/development/implementation/logging.html """ logentry_object_link = EventPluginSignal() """ Arguments: ``logentry`` -To display the relationship of an instance of the ``LogEntry`` model to another model -to a human user, ``pretix.base.signals.logentry_object_link`` will be sent out with a -``logentry`` argument. - -The first received response that is not ``None`` will be used to display the related object -to the user. The receivers are expected to return a HTML link. The internal implementation -builds the links like this:: - - a_text = _('Tax rule {val}') - a_map = { - 'href': reverse('control:event.settings.tax.edit', kwargs={ - 'event': sender.slug, - 'organizer': sender.organizer.slug, - 'rule': logentry.content_object.id - }), - 'val': escape(logentry.content_object.name), - } - a_map['val'] = '{val}'.format_map(a_map) - return a_text.format_map(a_map) - -Make sure that any user content in the HTML code you return is properly escaped! -As with all event-plugin signals, the ``sender`` keyword argument will contain the event. +**DEPRECTATION:** Please do not use this signal for new LogEntry types. Use the log_entry_types +registry instead, as described in https://docs.pretix.eu/en/latest/development/implementation/logging.html """ requiredaction_display = EventPluginSignal()