Praxisbeispiel: Plugin "Close Old Threads"

Plugin-Entwicklung



Im folgenden Beispiel wird die Entwicklung des Plugins "Close Old Threads" beschrieben.

0) Anforderungen


Oft passiert es, dass gerade neue Mitglieder ein altes Thema über die Suchfunktion auffinden und dort posten, obwohl bereits eine lange Zeit kein Beitrag mehr in diesem Thema geschrieben wurde. Für den Administrator ist es aber unzumutbar, ständig das Forum zu kontrollieren, um alte Beiträge zu schließen. Das neue Plugin soll dem Admin diese Arbeit abnehmen und beim Aufruf eines Themas automatisch prüfen, ob ein Thema zu alt ist oder nicht.
Für Themen die ein bestimmtes Alter überschritten haben, kann ein Warnhinweis angegeben werden, noch ältere Themen werden komplett geschlossen.

Der Administrator soll festlegen können, nach wie vielen Tagen eine Warnung bzw. eine Schließung erfolgt. Außerdem solle es möglich sein Gruppen zu definieren, die von der Schließung nicht betroffen sind.




1) Neues Plugin erstellen



In der Foren-Administration unter Plugins->Plugin Entwicklung können neue Plugins erstellt werden.

Plugin ID & Plugin Name
Die ersten beiden Werte, die bei der Erstellung eines Plugins angegeben werden müssen sind die Plugin ID und der Plugin Name. Die ID ist der interne Name des Plugins. Er darf keine Sonderzeichen enthalten. Der Pugin Name ist der Name des Plugins, den später der Endbenutzer zu sehen bekommt.


Plugin ID: threadautoclose
Plugin Name: Close Old Threads




2) Elemente des Plugins definieren



Ein Plugin besteht aus folgenden Elementen:

  • Content-Element
    Template-Elemente, Javascript oder HTML-Dateien
  • Config-Variablen
    Einstellungen für das Plugin
  • Daten-Variablen
    In diesen Variablen werden Werte und Daten gespeichert, die das Plugin benötigt. Datenvariablen werden immer einer Quelle (Origin) zugeordnet. Wird eine Variable z.B. dem Benutzerprofil zugeordnet, stehen die gespeicherten Werte später immer zur Verfügung, wenn ein Benutzerprofil geöffnet ist.
  • Globale Variablen
    Funktionieren genau wie Daten-Variablen, allerdings stehen die hier gespeicherten Werte später auf allen Seiten des Forums zur Verfügung. Dies kann die Performanz negativ beeinflusssen und sollte daher vorsichtig eingesetzt werden.



Für das Close Old Threads Plugin benötigen wir keine Variablen, die Daten speichern. Allerdings möchten wir dem Administartor einige Einstellungen ermöglichen, daher legen wir drei Config-Variablen an:

Variablen
1) maxdays_messageage_warning
Nach X Tagen soll eine Warnung angezeigt werden, dass das Thema schon alt ist.
Die Variable ist von Typ int und bekommt den Standardwert 180

2) maxdays_messageage_close
Nach X Tagen soll das Thema ganz geschlossen werden.
Die Variable ist von Typ int und bekommt den Standardwert 360

3) plugin_exceptions
Hier können Gruppen angegeben werden, welche auch nach dem erreichen von maxdays_messageage_close noch antworten können.
Die Variable ist vom Typ grouprights und bekommt den Standardwert administrator

Templates
Das Plugin soll später an zunächst 2 Stellen im Forum aktiv werden: Einmal beim Schreiben eines Beitrags, und einmal in der Themenansicht.

Wir benötigen daher 2 neue Template-Elemente:

Plugin Template Element "New Message"


Wir ordnen unser neues Element dem Foren-Template "Neuen Beitrag Schreiben" zu und erreichen damit, dass der Code des Templates immer ausgeführt wird, wenn das Template "Neuen Beitrag Schreiben" aufgerufen wird.


Desweiteren können wir festlegen, wann genau das Plugin Template ausgeführt werden soll:


Header -> das Plugin-Template wird direkt VOR dem Foren-Template ausgeführt.
Footer -> das Plugin-Template wird direkt NACH dem Foren-Template ausgeführt.
Inline-Element -> Die ermöglich die Ausführung der Plugin-Codes innerhalbt des Foren-Templates. Hierzu gibt es in den Foren-Templates Markierungen. Im "Neuen Beitrag Schreiben"-Template gibt es eine solche Markierung z.B. innerhalb des "Beitrag Schreiben" Formulars. Zu den Markierungen in den Template -Elementen wird es in Kürze noch ein eigenes Tutorial geben.


Unsere Einstellungen für das Element "New Message" lauten also:
Template: Neuen Beitrag Schreiben
Inline-Element: "new_message_in_form" (Name der Markierung im Foren Template)
Template Name: new_message

Analog dazu wird auch das Template "topic" angelegt:
Template: Themen Ansicht
Header: JA - das Plugin-Template soll vor dem Laden der Beiträge angezeigt werden.
Template Name: topic





3) Plugin Elemente schreiben


Wir haben nun alle Elemente des Plugins definiert und den jeweiligen Foren-Templates zugeordnet. Im nächsten Schritt schreiben wir nun den Code des Plugins

Plugin-Templates funktionieren fast genau wie normale Foren-Templates. Es stehen alle Foren-Variablen zur Verfügung, die auch im verknüpften Template-Element verwencet werden. Außerdem stehen die Variablen des Plugins zur Verfügung.

Auf den Wert der Variablen maxdays_messageage_warningzum Beispiel kann im Plugin Template mit {{plugin_threadautoclose_config_maxdays_messageage_warning}} zugegriffen werden.
Für Rechtevariablen erzeugt das System automatisch eine zusätzliche boolean-Variable. D.h während die Variable {{plugin_threadautoclose_config_plugin_exceptions}} die Gruppen-Ids der Gruppen enthält, die von der Themenschließung nicht betroffen sind, enthält {{plugin_threadautoclose_config_plugin_exceptions_boolean}} einen true/false Wert, der für den aktuellen Benutzer angepasst wird.


Das Element new_message setzt folgendes um:

Beim laden von "Neuen Beitrag Schreiben" prüfen wir ob

1) Das maximale Themenalter erreicht wurde
1a) Falls ja: Prüfen Ob das Mitglied in der "Ausnahmen"-Gruppe ist.
1aa) Falls ja: Warnhinweis anzeigen, dass das Thema eigentlich geschlossen wäre
1ab) Falls nein: Thema als geschlossen anzeigen, Laden des "Beitrag schreiben" Templates unterbinden

2) Das Themenalter für eine Warnung reicht:
2a) Falls ja: Warnung anzeigen

Das könnte dann z.B. so aussehen:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
<!--{{reply==true.start}} = Nur laden, wenn geantwortet wird:-->
{{reply==true.start}}
 
<!--Berechnung der Tage seit der letzten Antwort-->
{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}
 
{{limitreached.start}}0{{limitreached.end}}
 
<!--Thread ist älter als in maxdays_messageage_close definiert-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}

 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
<!--Thread ist älter als in maxdays_messageage_close definiert - aber der USer ist in einer ausgenommenen Gruppe-->
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">In diesem Thema wurden seit mehr als {{plugin_threadautoclose_config_maxdays_messageage_close}} Tagen kein Beitrag verfasst. <br/>Bitte überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen</div>
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
<!--Thread ist älter als in maxdays_messageage_close definiert - Thema wird als geschlossen angezeigt-->
<div class="threadinactive_hardlimit" style="text-align:center;">
Dieses Thema wurde aufgrund von Inaktivität geschlossen. <br/>Bitte eröffnen Sie bei Bedarf ein neues Thema.<br/>
<a href="{{reply_message_link}}" class="button button1">zurück zum Beitrag</a>
</div>

<!--Diese Funktionen veerhindern, dass weitere Templates geladen werden-->
{{template_stoploading(new_message)}}
{{template_stoploading(quote_html)}}
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}
 
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}
 
<!--Thread ist älter als in maxdays_messageage_warning definiert - Warnhinweis anzeigen-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.start}}{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">Bitte beachten Sie, dass in diesem Thema schon länger kein Beitrag mehr verfasst wurde.<br/>Überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen.</div>
{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.end}}{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.end}}
 

<!--Hier wird der eingefügte Code per Javascript auf der Seite positioniert. Je nach Template wird er an eine unterschiedliche Position geschoben-->
{{limitreached==true.start}}
 
<script>
$(document).ready(function(){
{{template==1.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==1.end}}
{{template==111.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==111.end}}
{{template==110.start}}var $infotexttarget = $(".submit-buttons");{{template==110.end}}
{{template==144.start}}var $infotexttarget = $("#newmsg");{{template==144.end}}
$('.threadinactive').insertBefore($infotexttarget);
});</script>
{{limitreached==true.end}}
{{reply==true.end}}
 



Das Element "topic" wird auf der Themen Ansicht geladen. Für die erste Version des Plugins beschränken wir uns darauf, die Schnellantwort auszublenden, wenn das Limit überschritten wurde (da Mitglieder ja sonst auf diesem Wege dennoch Beiträge schreiben könnten).


{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}

{{limitreached.start}}0{{limitreached.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
{{limitreached.start}}1{{limitreached.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
{{reply_quick.start}}0{{reply_quick.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}




4) Testen



Wenn alles klappt, sollten nun beim beantworten alter Themen keine Antwort mehr möglich sein.




5) Veröffentlichen



An dieser Stelle ist die erste Version des Plugins fertig für die Veröffentlichung im Plugin-Store. Dazu geben wir in den Plugin-Einstellungen die gewünschte Versionsnummer an (Falls bereits eine Version des Plugins veröffentlicht wurde muss die versionsnummer höher sein als zuvor!) und klicken auf "In Plugin Store veröffentlichen. Da wir bei den Plugin-Einstellungen festgelegt haben, dass das Plugin sichtbar für alle ist (Public Store) erscheint das Plugin nun im öffentlichen Plugin Store, sobald ein Xobor Mitarbeiter den Code überprüft und für gut befunden hat.

Ist das Plugin erst einmal im Plugin Store, kann es von allen Xobor Foren mit einem Klick installiert und verwendet werden.

6) Erweitern



Die Arbeit hört hier natürlich nicht auf. Man könnte noch Variablen hinzufügen, die dem Admin erlauben, selbst die angezeigten Texte festzulegen. Oder man fügt bei der Themen-Ansicht gleich das "Thema geschlossen"-Icon ein wenn das Antworten nicht gestattet ist.

Nachdem ein Plugin verändert wurde, muss eine neue Versionsnummer angegeben werden, bevor es im Plugin Store veröffentlicht werden kann. Ist eine neue Version verfügbar, können alle Foren das Update mit einem Klick installieren.


Login
Activity Feed
rating rating
nighti hat sich bedankt!
Beitrag: Kapazitätserweiterung - Neue Server für Xobor
%usernames% hat sich bedankt!
forum_topic forum_topic
balea hat das Thema Foren-Chat erstellt
Seid heute geht der Foren-Chat bei uns nicht. Er geht zwar auf, aber es erscheinen keine Namen. Könnte da mal jemand nach schauen?
forum_message forum_message
Jack Sallow, Ingmar und Johannes haben 5 neue Beiträge im Thema Forum Übersicht völlig zerrissen geschrieben.
Hallo oder schon guten Morgen? Tatsächlich habe ich.. nach stundenlanger Suche und Recherche den Fehler gefunden, der bei uns zuvor nie einen Fehler ausgelöst hatte und dafür gesorgt hat, dass der Template-Compiler abgestürzt ist. Das habe ich korrigiert und jetzt läuft alles wieder einwandfrei. Man...
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
markusp hat einen neuen Beitrag im Thema Ziellink in der Navigation ändern geht nicht geschrieben.
@Ingmar also ich kann jetzt gerade in Layout - Navigation das "r" wegmachen, gut.Aber es kommt wieder 8-)Layout - Navigation - ein Board auswählen, hier bei mir im Loewenfrankfurt-playground.de das "Mod-Board" das "für alle sichtbar" ist und das soll geändert werden. Im Adminweitere Einstellungen - ...
forum_message forum_message
l2otbart_57 und JanB haben 2 neue Beiträge im Thema Nach Server-Umzug funzt die Suche nicht geschrieben.
Zitat von JanB im Beitrag #2.... Alles wieder OK. 👍🏻 nein leider nichtim V4 haben die Folgeseiten der Suche eine komische URL: (&page=)-Parameter doppelt, zb für Seite 61 ..../search.php?q=test ..... &orderdirection=DESC&perpage=50&page=&page=6 
rating rating
Johannes hat sich bedankt!
Beitrag: Nach Server-Umzug funzt die Suche nicht
%usernames% hat sich bedankt!
forum_message forum_message
Johannes und 6 weitere haben 13 neue Beiträge im Thema Forum existiert nicht mehr????? geschrieben.
es geht wohl um https://colorful-river.xobor.de/
rating rating
Janine Fuchs hat sich bedankt!
Beitrag: Forum existiert nicht mehr?????
%usernames% hat sich bedankt!
rating rating
BeNew und 3 weitere haben sich bedankt!
Beitrag: Forum existiert nicht mehr?????
%usernames% haben sich bedankt!
forum_topic forum_topic
JanB hat das Thema Nach Server-Umzug funzt die Suche nicht erstellt
Vielleicht besser getrennt als 'Bug', dass unsere Suche nach dem Umzug vorhin nicht mehr funktioniert,auch wenns ein Anschluss-Thema ist zu "Forum existiert nicht mehr" und ähnlich ist zum Thema "Suche (funktioniert nicht mehr)".
rating rating
ADullham hat sich bedankt!
Beitrag: Kapazitätserweiterung - Neue Server für Xobor
%usernames% hat sich bedankt!
forum_topic forum_topic
Nicole Gerling hat das Thema Forum existiert nicht mehr????? erstellt
Hallo in die Runde,ich war heute morgen ganz normal in meinem Forum und jetzt ist es weg. Es ist ein Standart Forum, kostenlos. Wir sind nur zu zweit. Jetzt ist es weg. Kann mir einer erklären warum???Grüße Nicole/Schnubbel
forum_message forum_message
Guten Morgen,wir haben eben dieses Problem bei uns - seit 5min.Liebste Grüße!851184 | Gaia
rating rating
Ingmar hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Mir wurde bestätigt, daß jetzt alles wieder prima funktioniert. Nochmal recht herzlichen Dank!Kordula
rating rating
zickzack und 1 weitere haben sich bedankt!
Beitrag: Ziellink in der Navigation ändern geht nicht
%usernames% haben sich bedankt!
rating rating
Charles und 2 weitere haben sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% haben sich bedankt!
rating rating
Charles hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Admin Ansicht ist in der Free Version anders?
%usernames% hat sich bedankt!
rating rating
Knox hat sich bedankt!
Beitrag: Admin Ansicht ist in der Free Version anders?
%usernames% hat sich bedankt!
forum_message forum_message
Knox und 1 weitere haben 2 neue Beiträge im Thema Admin Ansicht ist in der Free Version anders? geschrieben.
So einfach ist die Lösung. Vielen Dank. Das hab ich wirklich glatt übersehen.
forum_topic forum_topic
Knox hat das Thema Admin Ansicht ist in der Free Version anders? erstellt
Hey zusammen,ich hab jetzt nicht explizit das selbe gefunden wie ich hier zeigen kann - aber vielleicht übersehe ich etwas und jemand kann mir helfen oder erklären was der Unterschied ist.Ich bin derzeit am rumcoden und baue neue Features fürs Hauptforum. Die teste ich natürlich vorher in einem kost...
rating rating
spotter46 hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
forum_message forum_message
Kipper-Spedition und 1 weitere haben 2 neue Beiträge im Thema Unsere Top 500 Xobor-Foren geschrieben.
Mal ehrlich, schaut ihr jeden Tag, wie hoch ihr im Ranking beim "XOBOR Top 500 seit?Spaß beiseite, aber auf die Größe kommt es ja nun wirklich nicht an...Armer @Johannes
forum_message forum_message
Kipper-Spedition und 3 weitere haben 6 neue Beiträge im Thema Ziellink in der Navigation ändern geht nicht geschrieben.
Aktuell kann ich keine Benutzergruppe in der Navigation ändern!Der Haken wird gelöscht - speichern - der Haken ist wieder drin!Wo ist der Haken liebes XOBOR-Team? Bzw. warum ist der Haken wieder da?
rating rating
markusp hat sich bedankt!
Beitrag: Ziellink in der Navigation ändern geht nicht
%usernames% hat sich bedankt!
rating rating
zickzack hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
spotter46 und 2 weitere haben sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% haben sich bedankt!
rating rating
Lady of the light hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und 2 weitere haben 3 neue Beiträge im Thema Unsere Top 500 Xobor-Foren geschrieben.
Zitat von Johannes im Beitrag #36Heute wird zum Beispiel ein weiterer alter Server migriert, damit wir in den kommenden Wochen und Monaten nach vorne schauen können und viele neue Interessante Dinge bei Xobor vorstellen können.Dann werden wir mal fest die Daumen drücken dass es nicht so holprig wird...
forum_message forum_message
Jaden hat einen neuen Beitrag im Thema Portalboxen bearbeiten nicht möglich geschrieben.
Hallo Ingmar.Heute morgen hat es endlich funktioniert.
rating rating
%usernames% hat sich bedankt!
rsummary rsummary
Janine Fuchs und 4 weitere haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Ingmar und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
zickzack und 5 weitere haben 5 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
markusp und 4 weitere haben 4 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
4 Mitglieder und 63 Gäste sind Online
Besucher Statistiken
67 Aktive User
4 Mitglieder und 63 Gäste sind Online:
Mike48, Johannes, nighti, Katja Diehl


Besucherrekord
2542 Benutzer gleichzeitig online (25.03.2026 01:44)

Besucherzähler
Heute waren 3542 Gäste und 26 Mitglieder, gestern 6019 Gäste und 44 Mitglieder online.

Statistiken
Themen 42386
Beiträge 311359
Mitglieder 12.664
Forum empfehlen