Jetzt hab ich mal den grossen Sprung gewagt und meinen lokalen Webserver neu installiert, weil ich ab jetzt mit PHP 8 arbeiten möchte. Ich hab mir den neuesten Xampp bei Chip runtergeladen, das alte Verzeichnis gesichert (lief schlappe 3 Stunden für gut 2 Gig) Xampp deinstalliert und neu installiert. Das hat zwar auch etwas länger gedauert, ist aber problemlos verlaufen. Das Control Panel musste ich dann zwar als Admin starten, aber das ist nur eine Kleinigkeit. Der Webserver lief auf Anhieb, ich hab dann gleich mal mit dem Duplicator den schwarzen Pinguin draufgenudelt – das hat gedauert! Am Anfang gabs zwar eine Fehlermeldung dass ein ZIP-Dienst nicht verfügbar wäre, aber dazu kam auch der Tipp dass man das Paket manuell entpacken könnte und den Installer dann nochmal starten kann. Lief problemlos durch – dauerte aber schon eine halbe Stunde.  Na fein, scheint alles zu laufen. Jetzt geh ich nochmal meine Plugins testen.

The good news first: das erste Plugin Stichworttabelle lief ohne Fehler durch und hat die CSV-Datei einwandfrei erzeugt.

Das zweite Plugin StichwortShortcode warf bei der Aktivierung einen Fehler: „Das Plugin erzeugte 2 Zeichen mit unerwarteter Ausgabe während der Aktivierung. Wenn du „headers already sent“-Hinweise, Probleme mit Syndication-Feeds oder andere Probleme bemerkst, versuche, dieses Plugin zu deaktivieren oder zu entfernen.“

Das ist natürlich weniger schön, aber dieser Fehler ist notorisch schwer zu lokalisieren, ich habs mal trotzdem aufgerufen. Erst die Konfiguration gespeichert, dann den Shortcode in eine neue Seite eingefügt – was soll ich sagen, hat auf Anhieb gefunkt und ein schönes Stichwortregister erzeugt. Das Einzige was mir dabei nicht so gut gefallen hat: bei diesem Blog sind jede Menge groß geschriebene Füllwörter mit reingerutscht (Und, So, Da,..) da brauchts eine Negativ-Liste. Da muss ich mal meinen Grips arbeiten lassen, das wäre schon very nice to have.

Das ist mir jetzt schon direkt ein bisschen unheimlich, normalerweise gehen bei solchen ersten Tests immer jede Menge Dinge schief und man kriegt -zig Fehlermeldungen. War nicht, ich hab anscheinend recht sauber programmiert.

Jetzt auf zu neuen Ufern: wie mach ich das mit der Negativ-Liste?

Aber ehrlich gesagt: ich muss zuerst bei der Konfiguration des Shortcode Plugins nochmal ran. Man sollte schon eine bestehende Konfiguration löschen und neu erzeugen können, da muss ich an der Benutzerführung noch was tun. Und vielleicht sollte ich mir auch Gedanken darüber machen, wie die CSV-Datei ins richtige Verzeichnis kommt. Ach ja, mir wird nicht langweilig 😉

Ich habe mir gerade eine lokale Sicherungskopie dieses Blogs erstellt, weil ich damit mein Stichwort-Plugin testen möchte. Siehe hierzu übrigens folgende sehr informative Seite: bestehendes WordPress Blog…lokal kopieren (schon etwas älter, funkt aber)

Und, was soll ich sagen: ich wollte die Widgets anpassen, weil ein paar davon Fehlermeldungen geschmissen haben, und der Widget-Editor kam im neuen Gewand als Blockeditor und hat Kraut, Rüben und Fehler geliefert. Flugs das Plugin Classic Widget gesucht, gefunden und installiert, und schon läuft es wieder rund mit den Widgets. Oh Mann… ich liebe Gutenberg wirklich! 😉

Mal gucken, wie stabil der lokale Blog läuft, ich werde jetzt testen ob mein Stichwort Plugin tut was es soll. Es bleibt spannend!

Man nehme: den Shortcode [el_stichwort] und füge ihn in einer Seite deiner Wahl ein:

Das erzeugt zunächst aus der CSV-Datei ein Stichwortregister mit weiterführenden Links:

Klick auf ein Stichwort öffnet eine Linkliste mit den zu diesem Stichwort gefundenen Rezepten:

Klick auf den Link öffnet das Rezept:

Eine runde Sache, und wenn ichs selber sage. Es ist noch ein bisschen Feinarbeit nötig, evtl. Sollte ich meine beiden Plugins zusammenfassen, aber das ist mir bei meiner mangelnden Fehlerbehandlung zu tricky. Eigentlich kam ich auf die Idee mit der Aufteilung in zwei Plugins daher, dass ich dank Gutenberg ständig Fehler bei der Shortcode-Ausführung hatte. Muss man sich mal vorstellen… das ist schon schwer buggy.

Ich lass es jetzt erstmal gut sein. Es war ein spannendes Projekt. Vielleicht mach ich noch die Positiv/Negativliste, wenns mich anspringt, aber jetzt ist erst mal Pause.

Natürlich hab ich (design as you go) den PAP noch ein paar mal radikal geändert und das Konzept einige Male wieder über den Haufen geschmissen. Aber jetzt läuft zumindest eine Rohfassung, und die möchte ich euch nicht vorenthalten. Was bei mir wie immer fehlt ist eine Foolproof Fehlerbehandlung, da müsste man noch einiges tun. So wie es ist kann man das Ding keinesfalls in einer echten, life WordPress Installation verwenden, das wäre selbstmörderisch. Aber auf meinem lokalen Webserver ist es gut aufgehoben und kann als Ausgangsmaterial für ein vernünftiges Plugin dienen.

Die wichtigsten Punkte in meinem umgearbeiteten PAP im Überblick:

• es gibt zwei Plugins. Eins erstellt die CSV-Datei mit den Stichworten aus den Titeln der Beiträge. Das zweite erzeugt eine Konfiguration für die Ausgabe (später mehr) und stellt einen Shortcode bereit, der das Stichwortverzeichnis an einer beliebigen Stelle (Seite) erzeugt.
• Die CSV-Datei findet auf wundersame Weise ihren Weg in das Verzeichnis des zweiten Plugins. Das Plugin liest die Datei zeilenweise in ein Array ein und erzeugt daraus ein hübsch alfabetisch sortiertes Stichwortregister. Klick auf ein Stichwort öffnet eine Unterseite und gibt als Parameter das aktuelle Stichwort mit.
• Damit eine Liste der gefundenen Beiträge zu einem Stichwort ausgegeben werden kann, ist die Ausgabe auf einer Unterseite zwingend notwendig. Dies ist eine ganz normale WordPress-Seite, die beim Anlegen der Plugin-Konfiguration neu erzeugt wird. Sie enthält nur einen Shortcode, der den beim Aufruf übergebenen Parameter stichwort übernimmt und daraus eine Liste der Beiträge zu diesem Stichwort erstellt. Die ID und der Permalink dieser Seite werden in der wp_options gespeichert. Diese Seite taucht auch ganz normal unter „Alle Seiten“ auf. Wenn man sie löscht – Pech. Da fehlt wieder die Fehlerbehandlung.
• Vorläufig gibt es keine Möglichkeit, die Konfiguration des zweiten Plugins nachträglich zu ändern. Für Entwickler: man kann die Einträge in der wp_options manuell löschen, dann kann man die Konfiguration neu schreiben. Das sollte man aber nicht im laufenden Betrieb tun, Pfusch auf der Datenbank kann zu Serverabstürzen führen. Hier To Do.

So, genug ge-PAP-t. Jetzt wollen wir uns mal das Plugin ShortcodeStichwort näher ansehen.

Teil 1 die Konfiguration

Ich erzeuge zunächst einen Eintrag im Admin-Menü, wie gehabt:

//********************* Eintrag im Adminmenü erzeugen
  add_action('admin_menu', 'shortcodestichwort_plugin_setup_menu');
	
	function shortcodestichwort_plugin_setup_menu(){
    add_menu_page( 'ShortcodeStichwort', 'Shortcode Stichwort Konfiguration', 'manage_options', 'shortcodestichwort', 'shortcodestichwort_init' );
}

Dann gehts los: die Funktion shortcodestichwort_init fragt zuerst mal ab, ob eine Konfiguration bereits existiert, dazu hab ich einen Flag in der Options-Tabelle gesetzt:

function shortcodestichwort_init(){
	echo "<h2>Konfiguration für die Ausgabe Stichwortverzeichnis</h2>";
	
	//Prüfen, ob bereits eine Konfiguration gespeichert wurde
	$checkkonfig = get_option('stichwortkonfigexists');
	
	if ($checkkonfig == ""){
	echo "Noch keine Konfiguration gespeichert. Sie müssen einmal auf den Button Konfiguration speichern klicken. ";}

Der Button „Konfiguration speichern“ wird nur angezeigt, wenn noch keine Konfiguration vorhanden ist. Gleich mehr.

Wenn bereits eine KOnfiguration vorhanden ist, wird sie ausgelesen und angezeigt:

if ($checkkonfig == 'existiert'){
		echo "Konfiguration auslesen</br>";
		echo "Konfiguration: ".get_option('stichwortkonfigexists')."</br>";
		echo "Name der CSV-Datei: ".get_option('name_csvdatei')."</br>";
		echo "URL der Ausgabeseite: ".get_option('url_ausgabeseite')."</br>";
		echo "ID der Ausgabeseite: ".get_option('id_ausgabeseite')."</br>";
	}

Das Formular wird nur angezeigt, wenn noch keine Konfiguration vorhanden ist (To Do)…

//***************Begin Formular
//Formular und Button nur anzeigen, wenn Konfiguration noch nicht existiert
if ($checkkonfig == ""){
//Formular mit Buttons 
// Konfiguration speichern schreibt die Parameter in die wp_options

echo "<form action = '#' method = 'post'>";
	
	echo "<input type='submit' id='el_button2' name='ButtonKonfig' value='Konfiguration speichern'>";
	echo "</form>";
	
	if (isset($_POST['ButtonKonfig'])){
			
			return konfiguration_speichern();
		}
//*****************End Formular	
	
}

Die beim Klicken auf den Button aufgerufene Funktion konfiguration_speichern() macht Folgendes: Sie setzt den Flag stichwortkonfigexists und schreibt den Dateinamen der CSV-Datei in die wp_options. Dann wird die Ausgabeseite neu erstellt, sie kriegt gleich den Shortcode zur Erstellung der Linkliste mit. Dateiname und ID werden in der wp_options gespeichert.

function konfiguration_speichern(){
	echo "Ich speichere die Konfiguration";
	add_option('stichwortkonfigexists', 'existiert');
	add_option('name_csvdatei','stichwortliste.csv');
	
	
	//Hier wird die Ausgabeseite neu erstellt und gleich der Shortcode für die Unterseite mitgegeben
	
	$my_post = array(
          'post_title'    => 'Ausgabeseite für das Stichwortverzeichnis',
          'post_content'  => '[links_ausgeben]',
          'post_status'   => 'publish',
          'post_author'   => 1,
          'post_category' => array(1),
          'post_type'     => 'page'
          );

          // Insert the post into the database
          //wp_insert_post( $my_post );
		  $seite_erzeugen = wp_insert_post( $my_post );
		  
		  echo $seite_erzeugen;
		  echo get_permalink($seite_erzeugen);
		  $guid_seite = get_permalink($seite_erzeugen);
		  echo "Seite erzeugt";
		  //the_guid($my_post);
	
	//Ende Ausgabeseite neu erstellen
	
	//guid und ID in der Tabelle wp_options speichern
	add_option('url_ausgabeseite', $guid_seite);
	add_option ('id_ausgabeseite', $seite_erzeugen);
	
	
}

Das war Teil 1. Ich hol mir mal eine Tasse Tee, Kaffee hab ich heute schon genug gehabt 🙂

Teil 2: die Shortcodes

Ich muss meinen umgestrickten PAP nochmal korrigieren: ich erzeuge zwei Shortcodes. den ersten um das Stichwortregister anzuzeigen (Stichworte alfabetisch nach Buchstaben geordnet) und den zweiten um in der Unterseite die Linkliste anzuzeigen. Frisch ans Werk!

add_shortcode( 'el_stichwort', 'el_stichwort_handler_function' );

function el_stichwort_handler_function(){
	echo "<h2>Stichwortregister</h2>";

Jetzt wird die CSV-Datei zeilenweise eingelesen und auf ein Array gelegt. Die Funktion csv_einlesen schenke ich mir, das kann jeder selber komponieren. Hier ist noch eine Debug-Ausgabe mit der Größe des fertig eingelesenen Arrays drin.

//Variable für Liste bereitstellen
	$listenarray = array();	
	
	//csv-Datei einlesen
	$listenarray=csv_einlesen();
	
	echo "Sizeof listenarray :".sizeof($listenarray)."<br>";
	

Jetzt wirds spannend: ich steppe durch das Alphabet und gebe zu jedem Buchstaben die zugehörigen Stichwörter aus. Jedes Stichwort wird als Link formatiert, der die Unterseite (aus der wp_options) mit dem Parameter stichwort aufruft.

//Array mit Alfabet erzeugen
	$alphas = range('A', 'Z');

	//Durch alfabet durchsteppen
	foreach($alphas as $letter){
		
		
		echo "<h3>Buchstabe ".$letter."</h3></br>";
		
		//Nur einfügen, wenn mit dem richtigen Buchstaben anfängt
		foreach($listenarray as $einwort)
		{
			
			$hilf = substr($einwort,0,1);
			
			//***** Zeile mit a href und dem richtigen Pfad aufbauen ACHTUNG Absturzgefahr
			if ($hilf == $letter){
				
				//*****Ausgabeseite wert der Option holen und damit aufmachen
				$pfad_unterseite = get_option('url_ausgabeseite');
								
				//Link auf die Unterseite mit Übergabe des Stichworts als Parameter
				echo '<a href="', "".$pfad_unterseite."?stichwort=$einwort",' ",">', $einwort, '</a></br>';
			
			}
			
		}
		
		
	}//ende for each buchstabe

Schnieke Sache, nicht wahr? Fehlt nur noch der Code zur Erzeugung der Linkliste auf der Unterseite, den muss ich noch ein bisschen bereinigen, der Name der Tabelle Posts ist fest verdrahtet. Aber so funkt es. Ich gehe mit dem Stichwort zuerst ins Feld post_title und gebe die Treffer aus, dann gehe ich nochmal rein, in das Feld post_content (und nicht wie post_title) und gebe die ebenfalls aus. Thazzit!

//**********************Beginn Shortcode für die Ausgabe der Stichwortliste erzeugen To Do: Tabellenname iiiwpposts als Var generieren
add_shortcode( 'links_ausgeben', 'links_ausgeben_handler_function' );

function links_ausgeben_handler_function(){
	echo "<h2>Hier kommt die Linkliste:</h2>";
	
	$aktStichwort = $_GET['stichwort'];
	//echo $aktStichwort;

echo "<h3>".$aktStichwort."</h3>";
$neu=$aktStichwort;

global $wpdb;

//erst treffer aus dem Titel rausfischen
$alleposts = $wpdb->get_results("SELECT DISTINCT(post_title), guid from iii_wpposts where post_title like '%$neu%' and post_status = 'publish' and post_type = 'post'");

foreach ( $alleposts as $einpost ) 
{ 
  //echo $einpost->post_title, $einpost->guid."<br>";
	echo '<a href="', $einpost->guid, '/",">', $einpost->post_title, '</a></br>';

}


//dann treffer aus dem content ohne treffer aus dem title rausfischen(dubletten vermeiden)
$alleposts = $wpdb->get_results("SELECT DISTINCT(post_title), guid from iii_wpposts where post_title not like '%$neu%' and post_content like '%$neu%' and post_status = 'publish' and post_type = 'post'");

foreach ( $alleposts as $einpost ) 
{ 
 // echo $einpost->post_title, $einpost->guid."<br>";
	echo '<a href="', $einpost->guid, '/",">', $einpost->post_title, '</a></br>';

}
}//**********************Ende Shortcode für die Ausgabe der Stichwortliste erzeugen

Jetzt fehlen noch ein paar Screenshots, aber dafür gibts einen neuen Beitrag.

Tja, so kanns gehen. Meine Recherchen haben ergeben, das ich um eine eigens erstellte Ausgabeseite für das Stichwortverzeichnis nicht herumkomme. Mir schwebt da eine Lösung vor, dass ich den Plugin-Admin-Menüpunkt um eine Funktionalität erweitere: „Konfiguriere Ausgabeseite“. Da kann ich auf folgendes Snippet zurückgreifen:

$my_post = array(
          'post_title'    => 'hello',
          'post_content'  => 'This is my post.',
          'post_status'   => 'publish',
          'post_author'   => 1,
          'post_category' => array(1),
          'post_type'     => 'page'
          );

          // Insert the post into the database
          wp_insert_post( $my_post );

Dann müsste ich eigentlich die URL der neu erstellten Seite abgreifen können, und die wiederum könnte ich für die Erzeugung der Links verwenden. In die Seite muss natürlich noch ein Shortcode rein, der den übergebenen Parameter Stichwort auffängt und damit eine Liste der zu diesem Stichwort gefundenen Beiträge erstellt. Mit LInks aus der guid natürlich.

Halbwegs klar? Ich muss mir natürlich merken, wie meine Seite heißt und was sie für eine URL gekriegt hat, das erledige ich wahrscheinlich mit einem Eintrag in der wp_options. Da müsste ich sowieso ein paar Init-Werte reinschreiben, wie den CSV-Dateinamen, aber das ist nur so ein Randgedanke. Ich kann mir dann die Möglichkeit offenhalten, eine bereits existierende Ausgabeseite beizubehalten oder zu ersetzen, da muss ich mal gucken wie weit ich komme. Hach ja, morgen ist auch noch ein Tag. Es bleibt spannend.