{"id":1257,"date":"2018-06-10T18:04:35","date_gmt":"2018-06-10T16:04:35","guid":{"rendered":"http:\/\/evileu.de\/zum-schwarzen-pinguin\/?p=1257"},"modified":"2018-06-24T11:07:44","modified_gmt":"2018-06-24T09:07:44","slug":"shortcodes-echo-vs-return","status":"publish","type":"post","link":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/2018\/06\/10\/shortcodes-echo-vs-return\/","title":{"rendered":"Shortcodes: echo vs. return"},"content":{"rendered":"

Ich arbeite ja gern mit Shortcodes und packe da auch oft komplexere Funktionalit\u00e4ten rein, weil sie so praktisch sind. Wenn man allerdings Shortcodes in Beitr\u00e4ge einbinden will, die auch noch Text enthalten, muss man ein bisschen aufpassen mit den Ausgaben, wo man echo und wo man return verwendet, sonst kann es zu unerw\u00fcnschten Effekten kommen. Ich mach mal ein einfaches Beispiel.<\/p>\n

Simpler Shortcode mit return:<\/p>\n

function el_harmlosertext(){\r\n\u00a0\u00a0 \u00a0return \"<strong>Ich bin ein komplett harmloser ShortcodeText<\/strong>\";\r\n}\r\nadd_shortcode('harmlos','el_harmlosertext');<\/pre>\n
Den kann man im Fliesstext platzieren wo man will, er wird an der richtigen Stelle ausgef\u00fchrt. Im Editor sieht das so aus:<\/p>\n
\"editor\"
editor<\/p><\/div>\n
Das erzeugt diese Bildschirmausgabe:<\/p>\n
\"bildschirm\"
bildschirm<\/p><\/div>\n
\u00c4ndert man jedoch den Shortcode und macht aus dem return ein echo, funktioniert das nicht mehr, die Ausgabe erfolgt vor dem Fliesstext des Artikels.<\/p>\n
\"vor_fliesstext\"
vor_fliesstext<\/p><\/div>\n
Das ist etwas irritierend, und komplett l\u00e4stig wird es, wenn man zum Beispiel die Ergebnisse einer Datenbankabfrage ausgeben m\u00f6chte, die nicht so ohne weiteres in ein return-Statement zu packen sind. Ich stricke mal eine kurze Liste aller bisher ver\u00f6ffentlichten Posts, und m\u00f6chte diese am Ende meines Beitrags ausgeben. Der Shortcode sieht erstmal so aus:<\/p>\n
function el_mit_datenbankabfrage(){\r\n\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0 global $wpdb;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Bisherige Anzahl posts holen\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $alleposts = $wpdb->get_results( \"SELECT * from wp_posts where post_status like 'publish'\");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $anzahl = $wpdb->num_rows;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 echo $anzahl.\" Datens\u00e4tze gefunden und mit echo ausgegeben<br>\";\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $ausgabe = array();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$i=0;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach($alleposts as $einpost){\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 echo<\/span> $einpost->post_title.\"<br>\";\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \r\n}\r\nadd_shortcode('db_abfrage','el_mit_datenbankabfrage');<\/pre>\n
Hier kann man das echo nicht einfach mit einem return ersetzen, weil sonst der foreach nach dem ersten Durchgang abbricht. So lassen kann man es aber auch nicht, weil die Liste so wie der Shortcode jetzt aussieht immer vor dem Fliesstext des Artikels ausgegeben wird:<\/p>\n
\"echo_vor_text\"
echo_vor_text<\/p><\/div>\n
Abhilfe: wir packen die Ausgaben des foreach in einen String und verketten den innerhalb der Schleife. Die Funktion des Shortcodes wird wie folgt ge\u00e4ndert:<\/p>\n
function el_mit_datenbankabfrage(){\r\n\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0 global $wpdb;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Bisherige Anzahl posts holen\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $alleposts = $wpdb->get_results( \"SELECT * from wp_posts where post_status like 'publish'\");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $anzahl = $wpdb->num_rows;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 echo $anzahl.\" Datens\u00e4tze gefunden und mit echo ausgegeben<br>\";\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $ausgabe = \"\";<\/span>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 <\/span>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach($alleposts as $einpost){<\/span>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0  \u00a0$ausgabe=$ausgabe.$einpost->post_title.\"<br>\";<\/span>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/span>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }<\/span>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0return \"Mit return ausgegeben:<br>\".$ausgabe;\r\n}<\/pre>\n
Diesen String gebe ich dann mit dem return der Shortcode-Funktion zur\u00fcck, und meine Liste wird brav ans Ende des Beitrags gestellt, da wo ich sie auch haben will.<\/p>\n
\"return\"
return<\/p><\/div>\n
Ich k\u00f6nnte die Ausgabe auch mitten im Text platzieren, funktioniert auch. Man sieht hier auch noch, dass die mit echo ausgegebene Anzahl der Datens\u00e4tze gnadenlos vor dem Beitragstext landet:<\/p>\n
\"mitten_im_text\"
mitten_im_text<\/p><\/div>\n
Das ist alles nat\u00fcrlich nur relevant, wenn man den Shortcode auf einer Seite oder auf einem Beitrag platzieren m\u00f6chte, die sonst auch noch Text enthalten, bei sonst leeren Posts\/Pages ist es egal. Wissen muss man halt, dass return und echo hier v\u00f6llig unterschiedliche Effekte in der Ausgabe erzielen, dann kann man auch gegensteuern.<\/p>\n","protected":false},"excerpt":{"rendered":"
Ich arbeite ja gern mit Shortcodes und packe da auch oft komplexere Funktionalit\u00e4ten rein, weil sie so praktisch sind. Wenn man allerdings Shortcodes in Beitr\u00e4ge einbinden will, die auch noch Text enthalten, muss man ein bisschen aufpassen mit den Ausgaben, wo man echo und wo man return verwendet, sonst kann es zu unerw\u00fcnschten Effekten kommen. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1,14],"tags":[],"_links":{"self":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1257"}],"collection":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/comments?post=1257"}],"version-history":[{"count":5,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1257\/revisions"}],"predecessor-version":[{"id":1312,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1257\/revisions\/1312"}],"wp:attachment":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/media?parent=1257"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/categories?post=1257"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/tags?post=1257"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}