XoviLichter-Ranking für alle – Das WordPress-Plugin

Vor einigen Tagen hatte ich ja bereits die maschinenlesbaren Daten von aus.gerech.net vorgestellt. Dort hatte ich auch ein paar Zeilen PHP-Code für die Nutzung der Daten angekündigt. Nun sind aus den paar Zeilen doch eine WordPress-Plugin geworden, welches ich hier kurz vorstellen will.

Xovilichter Top-100 Liste

123 Top-100 Plugin

Das Plugin besteht im wesentlichen aus zwei Funktionen.

Die erste Funktion agn_top100_read_data ist für das Abholen der Daten im JSON-Format zuständig. Hier habe ich etwas mehr Aufwand betrieben, um unnötige Requests und Datenübertragungen zu vermeiden. Die Daten werden lokal auf dem Server der WordPress-Installation im Verzeichnis wp-content/uploads gespeichert. Dieses muß daher von WordPress beschreibbar sein, damit das Caching funktioniert.

Die zweite Funktion agn_top100_shortcode implementiert einen WordPress-Shortcode, mit dem man sich die gewünschten Daten im Artikel oder auf der Seite ausgeben lassen kann.

Im einfachsten Fall sieht das dann so aus:
...
Hier findet ihr die aktuelle XoviLichter Top-100:
<table class='chart-list'>[agn_top100]</table>
...

Per Voreinstellung wird die Liste als Tabelle ausgegeben, allerdings ohne Table-Tags. Die müßt Ihr selbst drumrum packen. Das hat den Vorteil, daß Ihr der Tabelle einfach eine CSS-Klasse oder sonstige Formatierungen mitgeben könnt.

In der Voreinstellung ergibt sich damit eine Tabelle wie auf dieser Beispielseite (ohne Grafik). Die Platzierung wird einfach durchnummeriert, vor der URL steht ggf. ein Symbol für den Ergebnistyp, hinter der URL folgt ein Link-Symbol mit einem (nofollow!) Link zur Seite. URLs, die Länger als 70 Zeichen sind, werden am Ende mit … verkürzt.

Über Shortcode-Parameter kann die Ausgabe angepaßt werden. Folgende Einstellungen sind möglich:

  • nam – Name der Daten
    Vorgabe: ‚xovilichter‚, bei zukünftigen SEO-Wettbewerben etwas anderes :-)
  • ret – Was soll der Shortcode zurückgeben?
    Vorgabe: ‚rnk‚, mögliche Werte

    • rnk – Ranking Tabelle/Liste (siehe lit)
    • upd – Datum und Zeit des letzten Updates (siehe dtf)
    • cnt – Anzahl der gefundenen Treffer insgesamt
  • max – Maximal Anzahl auszugebender Treffer
    Vorgabe: ‚100‚, eine Zahl zwischen 1 und 123
  • dtf – Ausgabeformat des letzten Updates (siehe ret:upd)
    Vorgabe: ‚‚d.m.Y H:i‘‚, Format entsprechend PHP-Date-Funktion
  • lit – Listentyp: Tabelle oder Liste?
    Vorgabe: ‚tab‚, mögliche Werte

    • tab – Tabelle (table)
    • lst – Liste (ol)
  • cut – Anzahl Zeichen, ab der eine URL verkürzt wird
    Vorgabe: ‚70‚, eine Zahl zwischen 0 (keine Verkürzung) und größer
  • sym – Typ-Symbol vor der URL anzeigen
    Vorgabe: ‚1‚, zum ausschalten ‚0‘ verwenden
  • lnk – Link am Ende der URL ausgeben
    Vorgabe: ‚1‚, zum ausschalten ‚0‘ verwenden

Hier ein paar Beispiele:
...
<ol>[agn_top100 max='33' lit='lst' sym='0']</ol>
...

Gibt maximal 33 Einträge als HTML-Liste (OL) ohne vorangestelltem Typ-Symbol aus.

...
Top-100 vom [agn_top100 ret='upd' dtf='l, d.m.Y H:i'] Uhr
...

Gibt den Zeitpunkt des letzten Updates formatiert aus.

Technische Voraussetzungen und Download

Technische Voraussetzungen:

  • WordPress 3.8 oder höher
  • PHP 5.2 oder höher mit curl-Funktion
  • Verzeichnis wp-content/uploads muß von WordPress beschreibbar sein

Download Version 0.14: 123 Top-100 Plugin

Falls es Unklarheiten oder Fragen gibt, einfach fragen. :-)

Weitere Artikel mit Bezug zu diesem:

7 Reaktionen zu “XoviLichter-Ranking für alle – Das WordPress-Plugin”

  1. Ronny sagt:

    Moin Ingo,

    ich wollte gerade dein Plugin ausprobieren. Wenn ich es samt Ordner in mein WP Plugin Verzeichnis lege, wird es im Backend nicht angezeigt… sprich, ich kann es nicht aktivieren. Ist das richtig so?

    Das Upload-Verzeichnis ist beschreibbar.

    VG, Ronny

  2. Wie „samt Ordner“? Es ist nur eine Datei, die plw123_top100.php, und die kommt direkt ins Plugin-Verzeichnis ohne Unterordner.

    Hmmm, habe ich etwa in der ZIP-Datei meine ganze Ordnerstruktur mit eingepackt? Das müßte ich dann nochmal ändern, es soll eigentlich nur die eine Datei „ordnerlos“ darin sein.

  3. Ronny sagt:

    Ok stimmt, daran kann es liegen. Ich bin es nur gewohnt, meine Plugins vorher zu entpacken und dann den Ordner hochzupacken. Ich habe mir mal mit einem infizierten Plugin eine Seite zerschossen und daher gucke ich vorher immer erst ins ZIP-Archiv. ;-)

    VG

  4. Ronny sagt:

    Ich habe es jetzt noch einmal getestet: aktivierien konnte ich das Plugin bereits, aber an der Stelle des eingefügten Shortcodes passiert nichts. Ich habe einmal mehrere Kombinationen von Shortcode-Parametern durchprobiert, aber eine Liste wird nicht ausgegeben. Deine Mindestanforderungen (WordPress, PHP und Uploads-Verzeichnis) erfülle ich. Hier habe ich es direkt unter der Ranking-Grafik eingebaut: http://ronny-marx.de/xovilichter/live-ranking/

    Mache ich noch irgendetwas falsch?

    VG, Ronny

  5. Es scheint so zu sein, als wenn die http-Requests bei Deinem Server/Webspace nicht rausgehen. Ich habe in meinen Logfiles zumindest noch keine Zugriffe gesehen.
    Für die Requests werden im Plugin die curl-Funktionen von PHP verwendet. Für diese muß ein ausgehender Zugriff möglich sein.

  6. Shivani sagt:

    Danke, ist interessant zu sehen wie es funktioniert – vorallem wenn man Leihe ist, und so mitbekommen was alles geht

  7. Fredy sagt:

    Hallo
    Läuft auf dem CH-Phonisten einwandfrei – thx, nur CSS muss ich mal wieder auffrischen. fg Fredy

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

 Hier kein Häkchen setzen
 Ich bin kein Spambot

Hinweis: Kommentare von bisher unbekannten Schreibern (Name und eMail) oder mit mehr als einem Link werden moderiert.