blog.tigion.de

Das Plugin Keksdosen Hallo oder täglich grüßt die Keksdose ist eine kleine Cookie-Spielerei für WordPress. Es liest den beim Kommentieren angelegten Cookie aus und begrüßt den Leser beim wiederholten Betrachten des Blogs mit einem zufälligen Willkommenstext. Die Texte können dabei in einer normalen oder selten Variante angegeben werden..

Hinweis: Diese Version ist aktuell nur in deutsch verfügbar. Ich übernehme kein Risiko für durch das Plugin entstandene Schäden. Bisherige Tests bei mir liefen fehlerfrei und ich bin über jeden Hinweis zur Fehlerbeseitigung oder Kritik dankbar.

Angefangen hatte es mit der Inspiration beim Nasendackel und der Spielerei Grüße aus der Keksdose. Nun ist das ganze als Plugin mit einigen zusätzlichen Optionen verpackt. Eventuell findet es ja jemand nützliche.

Voraussetzung

Das Plugin ist mit der Version 2.6 von WordPress bzw WordPress DE-Edition getestet wurden. Es sollte unter Vorbehalt weiterhin auch unter Version 2.3 und 2.5 laufen.

Wenn die Cookieabfrage von WordPress in älteren bzw. neueren Versionen gleich sein sollte, müsste es eigentlich auch dort funktionieren.

Download

• Version 0.4: keksdosen-hallo_0-4.zip
• Version 0.3: keksdosen-hallo_0-3.zip
• Version 0.2: keksdosen-hallo_0-2.zip
• Version 0.1: keksdosen-hallo_0-1.zip

Installation

1. Entpacke das heruntergeladene Archiv und kopiere den darin enthaltenen Ordner keksdosen-hallo in dein WordPress Installationsverzeichnis unter /wp-content/plugins/.
2. Aktiviere das Plugin Keksdosen Hallo in der Pluginverwaltung.

Update

1. Deaktiviere das Plugin Keksdosen Hallo in der Pluginverwaltung.
2. Sichere die keksdosen_hallo.php, um die angepassten Texte nicht zu verlieren.
3. Entpacke das heruntergeladene Archiv und Übertrage aus der gesicherten keksdosen_hallo.php die angepassten Texte in die neue Version der keksdosen_hallo.php Datei.
4. Kopiere/Lade den Ordner keksdosen-hallo in dein WordPress Installationsverzeichnis unter /wp-content/plugins/ und überschreibe dabei die ältere Version des Plugins.
5. Aktiviere das Plugin Keksdosen Hallo in der Pluginverwaltung.

Verwendung

An die gewünschte Stelle in der entsprechenden Datei des verwendeten Themes folgendes einfügen:

<?php if (function_exists('twp_keksdosen_hallo')) : ?>
  <?php twp_keksdosen_hallo(); ?>
<?php endif; ?>

oder:

<?php if (function_exists('twp_keksdosen_hallo')) {
  twp_keksdosen_hallo();
} ?>

Die Angabe der Funktion function_exists() ist notwendig, um Fehlern bei nicht aktivierter oder nicht vorhandener Funktion twp_keksdosen_hallo() vorzubeugen.

Es gibt drei Varianten der Funktion twp_keksdosen_hallo() Werte zu übergeben und somit das Verhalten zu beeinflußen.

Variante 1

Die einfachste für das Standardverhalten ist:

twp_keksdosen_hallo();

Variante 2

Möchte man zur Funktion gehörende Parameter angeben, werden ein oder mehrere mit & verknüpft Parameter in einfachen Hochkommas angegeben:

twp_keksdosen_hallo('rare_lvl=25&show_url=1');

Variante 3

Zusätzlich besteht noch die Möglichkeit, Text für eine zusätzliche Ausgabe vor und nach dem Willkommenstext anzugeben. Dies ist für extra HTML-Tags nützlich, welche nur bei einer Ausgabe des Plugins (bspw. bei show_unknown=0) verwendet werden sollen:

Hierbei ist zu beachten, daß die folgende Reihenfolge eingehalten wird und nicht benötigte Teile mit zwei einzelnen Hochkommas ‘ ‘ angegeben werden müssen:

• 1. Parameter (mehrere mit & verknüpft)
• 2. zusätzlicher Text vor dem Willkommenstext
• 3. zusätzlicher Text nach dem Willkommenstext

twp_keksdosen_hallo('rare_lvl=25', '<p>', '</p>');
twp_keksdosen_hallo('', '', '<br />&nbsp;');

Parameter

Es können folgende Parameter, welche das Aussehen und den Inhalt der Pluginausgabe beeinflussen, angegeben werden:

rare_lvl

• Legt den Faktor für die raren Willkommenstexte fest, wobei die Chance 1:rare_lvl besteht.
• Wird ein Wert von 0 angegeben, erfolgt keine Ausgabe der raren Texte. Der maximale Wert ist momentan pluginseitig auf 1000 begrenzt.
• Defaultwert (keine Angabe): Faktor beträgt 10, was einer Chance von 1:10 entspricht
• Bsp.: twp_keksdosen_hallo(‘rare_lvl=25′) … für eine Chance von 1:25 für rare Willkommenstexte

show_url

• Legt fest, ob der Namen mit einer im Cookie hinterlegte zugehörigen Webseite verlinkt ausgegeben werden soll. Ein Angabe von 0 führt zu keiner Ausgabe und eine 1 zu einer verlinkten Ausgabe.
• Defaultwert (keine Angabe): ’0′ für keine Ausgabe mit verlinkter Webseite
• Bsp.: twp_keksdosen_hallo(‘show_url=1′) … für Namens Anzeige mit verlinkter Webseite

show_unknown

• Ist kein Cookie vorhanden bzw. handelt es sich um einen Leser der noch nicht kommentiert hat, erfolgt die Ausgabe beispielsweise mit dem Synonym Fremder. Dieser Parameter legt fest, ob in dem Falle eine Ausgabe erfolgen soll (Wert: 1) oder das Plugin nur auf Leser mit entsprechenden Cookies reagieren soll (Wert: 0).
• Defaultwert (keine Angabe): 1, es werden auch Fremder begrüßt
• Bsp.: twp_keksdosen_hallo(‘show_unknown=0′) … keine Begrüßung von Fremden

Ausgabetexte anpassen

Die Texte lassen sich ganz einfach in der Datei keksdosen_hallo.php anpassen, wobei als Platzhalter für den Namen [USER] verwendet werden sollte.

Es sind die zwei Arrays $text_daily und $text_rare für die Texte vorhanden, in welchen die gewünschten Texte angegeben werden können:

// daily phrases
$text_daily = array (
  'Hallo [USER], danke fürs Kommentieren.',
  'Ein [USER], wie niedlich.',
  '... [USER], ...'
);

// rare phrases
$text_daily = array (
  'Special guest [USER] is in the house.',
  '[USER] [USER], immer wieder [USER].',
  '... [USER], ...'
);

Beim hinzufügen von Texten ist darauf zu achten, dass die Texte immer in den einfachen Hochkommas ‘ stehen und bis auf das Letzte immer mit einem Komma ‘,’ enden. Der Text an sich hängt natürlich von der eigenen Kreativität ab.

Changelog

• 0.4 – Anpassung an Cookies von WordPress 2.6 und Markierung ‘*’ wieder entfernt, sowie Code etwas aufgeräumt. (05.08.2008)
• 0.3 – Usererkennung per Cookie bei nur temporär angemeldeten WordPress Autoren und Markierung mit einem vorangestellten ‘*’. Namen mit mehr als 15 Zeichen werden mit ‘…’ am Ende eingekürzt. (29.07.2008)
• 0.2 – Name des WordPress Autors wird jetzt ebenfalls vom Cookie wordpressuser ausgelesen. Ist er vorhanden, wird er an Stelle des Kommentierer-Cookies verwendet. (09.11.2007)
• 0.1 – Initial Release, nicht perfekt aber geschlüpft (08.11.2007)

Todos / Feature Requests

• kreativere Texte
• Texte aus extra Dateien einlesen?