Tipps für das Schreiben von benutzerdefiniertem Code für Charitable

Ein Grund, warum Charitable eines der besten WordPress-Plugins für Kampagnen und Spenden ist, ist seine Flexibilität und die Fähigkeit, anderen zu ermöglichen, verschiedene Schlüsselaspekte des Erlebnisses anzupassen – einschließlich E-Mails, Kampagnendetails und des Spendenformulars. Ein Teil dieser Flexibilität liegt in den „Hooks und Filtern“ im Code von Charitable, die WordPress-Entwicklern zur Verfügung stehen. Über diese kann ein Entwickler eine Website anpassen, um:

— Ein benutzerdefiniertes Feld im Spendenformular über die Donations Field API anzuzeigen.
— Neue E-Mail-Tags hinzuzufügen oder bestehende mit der Email Fields API zu ändern.
— Anpassungen an Add-ons wie dem Ambassador Addon und dem Annual Receipts Addon vorzunehmen.

Code für ein WordPress-Plugin kann auf verschiedene Arten und an verschiedenen Stellen geschrieben werden: Einige Codes können in die Datei „functions.php“ des aktiven WordPress-Themes eingefügt werden, einige werden in ein Plugin geschrieben (das aktiviert und deaktiviert werden kann, auch wenn der Benutzer dasselbe Theme beibehält) und (was immer beliebter wird) Code kann in einem Code-Snippets-Plugin gehostet werden.

Unabhängig davon, wo sich der Code befindet, gibt es Best Practices, die WordPress-Entwickler und Coder anwenden sollten, um sicherzustellen, dass die Website, auf der er läuft, sicher bleibt und keine Fehler aufweist. Das Folgende ist kein vollständiger oder tiefgehender Leitfaden, sondern allgemeine Erinnerungen für diejenigen, die Code schreiben ODER Code von Entwicklern entgegennehmen, um ihn in ihre Website einzufügen – insbesondere wenn dieser Code auf einem Drittanbieter-Plugin (wie Charitable) basiert. 

Plugin-Datei bevorzugt

Wenn möglich, versuchen Sie, benutzerdefinierten Code in einem EIGENEN WordPress-Plugin zu platzieren. Dies erleichtert die Beibehaltung des Codes, wenn Sie Ihr WordPress-Theme wechseln, und ermöglicht es Ihnen auch, das Plugin mit den Anpassungen zu Aktivieren/Deaktivieren für Debugging-Zwecke. Es gibt viele Beiträge und Tutorials im Web über die Erstellung eines einfachen WordPress-Plugins wie diesem.

Nicht annehmen, immer prüfen

Es ist wichtig, dass benutzerdefinierter Code NICHT DAVON AUSGEHT, DASS CHARITABLE AUF IHRER WEBSITE AKTIVIERT UND AKTIV IST. Warum? Denn wenn versucht wird, eine Funktion im Kerncode von Charitable aufzurufen – und der Code nicht vorhanden ist – kann ein Fehler auftreten… ein Fehler, der Ihre Website lahmlegen könnte! Manchmal kann WordPress Ihre Website in den „Wiederherstellungsmodus“ versetzen und dem Website-Administrator eine E-Mail senden, um ihn über diesen Fehler zu informieren, aber das ist nicht immer der Fall. Daher sollte JEDER Code, der für Charitable geschrieben wurde – unabhängig von seinem Zweck oder seinem Speicherort –, „prüfen“, ob Charitable aktiviert ist und/oder die Funktion, die aufgerufen werden soll, existiert.

Beachten Sie unser erstes (schlechtes!) Beispiel:

👎🏻 SCHLECHTES BEISPIEL:

// Bad Example :-( Of Hooking Into Charitable

function charitable_add_donation_gateway_email_tag() {
    charitable()->donation_fields()->get_field( 'gateway_label' )->email_tag = true;
}
add_action( 'init', 'charitable_add_donation_gateway_email_tag' );

Der Zweck dieses Codeblocks ist es, das „Gateway-Label“ zu etwas zu machen, das als dynamisches Tag in Charitable-E-Mails hinzugefügt werden kann. Der obige Entwickler „hookt“ die Funktion, die dies tut, in das WordPress-„init“, das jedes Mal ausgeführt wird, wenn eine Seite auf der Website geladen wird – egal ob im Adminbereich oder im Frontend. Beachten Sie, dass die Funktion „charitable()“ verwendet… aber wenn diese nicht existiert, gibt PHP einen „fatal error“ aus – und da der obige Code bei JEDEM und JEDEM Seitenaufruf geladen wird, wird die gesamte Website höchstwahrscheinlich abstürzen, ohne die Möglichkeit, sich als Administrator anzumelden usw.

Auch hier ist es eine gute Praxis, niemals davon auszugehen, dass eine Funktion existiert, wenn diese Funktion Teil eines Plugins oder Themes ist (mit anderen Worten, wenn sie nicht Teil des WordPress-Kerns ist). Die Annahme, dass die „charitable()“-Klasse existiert, bedeutet die Annahme, dass das Charitable-Plugin IMMER vorhanden sein wird – aber wenn das Plugin deaktiviert ist (von einem Menschen oder einem anderen Plugin) oder wenn das Plugin aktualisiert wird… wird die Funktion nicht gefunden, und es würde ein (möglicherweise „fataler“) Fehler auftreten. Hier ist die gleiche Funktion, aber mit einer einfachen Ergänzung:

👍🏻 GUTES BEISPIEL:

// Good Example :-) Of Hooking Into Charitable
// Checking To See If The Class Exists!

function charitable_add_donation_gateway_email_tag() {
    if ( class_exists('charitable') ) : // check for class
       charitable()->donation_fields()->get_field( 'gateway_label' )->email_tag = true;
    endif;
}
add_action( 'init', 'mysite_charitable_add_donation_gateway_email_tag' );

Beachten Sie die „if“-Anweisung, die prüft, ob die Klasse „charitable“ existiert – dies ist eine Methode in PHP, um sicher zu prüfen, ob die Klasse existiert (in diesem Fall nur, wenn Charitable aktiv auf der Website läuft). Wenn sie nicht existiert, wird der Code nicht ausgeführt und alle sind sicher. Es ist üblich, dass PHP-Entwickler Prüfungen wie class_exists und function_exists verwenden, um schnell sicherzustellen, dass der Code, den sie ausführen wollen, keine schwerwiegenden Fehler verursacht, weil etwas, von dem sie annehmen, dass es existiert, nicht existiert.

Verwenden Sie eindeutige Namen für Funktionen

Wie in den obigen Beispielen erwähnt, geben Sie Ihren Funktionen niemals generische Namen wie „update_email“, denn wenn ein anderes Plugin denselben Namen verwendet (aktuelle Plugins oder zukünftige, die Sie möglicherweise installieren), kann Ihre Website Probleme erleiden. Wenn Sie eine Funktion erstellen, beginnen Sie immer mit „mywebsite_charitable_“ (wie im obigen Beispiel, wobei „mywebsite“ durch eine Zeichenkette von angemessener Länge Ihres Website-Namens ersetzt wird), um sicherzustellen, dass Sie wahrscheinlich einen benutzerdefinierten Namen erstellt haben, der nicht wiederholt wird (Sie können auch die gleiche „Existiert das bereits“-Logik im obigen Schritt verwenden, wenn Sie die Extra-Meile gehen möchten).

WordPress-Debugging und Debug-Logs aktivieren

Für alles, was über ein einfaches Skript hinausgeht, dokumentieren und protokollieren WordPress-Entwickler üblicherweise PHP-Warnungen und -Fehler, um Probleme „abzufangen“ (insbesondere wenn sie auf der Website nicht offensichtlich sichtbar sind). Das Charitable-Support-Team empfiehlt die Basis-Funktionen WP_DEBUG und WP_DEBUG_LOG, wie hier in der WordPress-Dokumentation erwähnt.

Verwenden Sie ein Code-Snippet-Plugin?

Alles oben Gesagte gilt auch für Code, der in Code-Snippet-Plugins eingefügt wird. Wenn Sie ein Problem mit Charitable haben und wissen, dass Sie benutzerdefinierten Code in einem Code-Snippet ausführen, sollten Sie in der Lage sein, das Code-Snippet-Plugin zu deaktivieren, um zu sehen, ob dies das Problem löst oder Ihnen bei der weiteren Fehlerbehebung hilft.

Nicht auf Produktionssystemen testen

Schließlich ist es eine gute Idee, benutzerdefinierten Code in einer Staging- oder Entwicklungsumgebung zu testen und nicht live auf Ihrer Website. Wenn Sie Charitable hier zu Testzwecken deaktivieren, ist dies eine gute „endgültige“ Methode, um festzustellen, ob Ihre Website erhebliche Probleme haben könnte. Dies schützt Ihre Produktionsumgebung und ermöglicht weiterhin Spenden. 


Denken Sie daran, dass Sie, wenn Sie sich über den Code, den Sie zu Ihrem Theme, Ihrem eigenen Plugin oder einem Code-Snippet-Plugin hinzufügen, unsicher sind, einen Entwickler konsultieren sollten. Wenn Sie allgemeine Fragen haben, können Sie sich gerne an unser Support-Team wenden, das Ihnen gerne Fragen zu jedem Code beantwortet, den Sie möglicherweise zu Ihrer Website hinzufügen, um Charitable zu erweitern. Wir sind für Sie da und unterstützen Sie bei der Erweiterung Ihrer Website, um Ihre Bedürfnisse zu erfüllen!

Wir hoffen, dass diese Vorschläge Ihnen das Vertrauen geben und sicherstellen, dass Ihre Anpassungen an Charitable noch viele Jahre lang gut funktionieren.

Erhalten Sie kostenlose Tipps und Ressourcen direkt in Ihren Posteingang, zusammen mit über 60.000 anderen

Abonnieren Sie unseren Newsletter

Wir werden Sie nicht spammen. Wir senden nur eine E-Mail, wenn wir glauben, dass sie Ihnen wirklich hilft. Abmeldung jederzeit möglich!

Video der Woche:

Sehen Sie sich weitere Videos auf unserem YouTube-Kanal an.

Was ist neu bei Charitable

Die neuesten Updates anzeigen
🔔 Abonnieren Sie, um unsere neuesten Updates zu erhalten
📧 E-Mails abonnieren

E-Mail-Abonnement

Abonnieren Sie unseren Newsletter

Wir werden Sie nicht spammen. Wir senden nur eine E-Mail, wenn wir glauben, dass sie Ihnen wirklich hilft. Abmeldung jederzeit möglich!

Botschafter Neu

🔑 Passworterose Spendenaktionen vorstellen: Melden Sie sich nur mit einer E-Mail-Adresse an!

Unterstützer kommen, um zu helfen, und dann bittet das Formular sie, ein Passwort für eine Website zu erfinden, die sie vielleicht nur zweimal besuchen. Viele von ihnen hören genau dort auf. Passworterose Spendenaktionskonten, neu in Charitable Ambassadors 3.5.0, ermöglichen es einem Unterstützer, eine Peer-to-Peer-Spendenaktion mit nichts weiter als einer E-Mail-Adresse zu starten. Warum das wichtig ist:

  • 🔑 Keine Passwortabfrage, die sie verliert: Schalten Sie es in Charitable » Ambassadors » Templates » Submit Form ein, und das Formular zum Erstellen von Spendenaktionen fragt nur nach einem Namen, einer E-Mail-Adresse und einem Seitentitel.
  • 👤 Immer noch ein echtes WordPress-Konto: Ein Klick in einer E-Mail bestätigt die Adresse, meldet sie an und erstellt das Konto, sodass sie später zurückkehren können, um ihre Geschichte zu bearbeiten, ihr Foto zu ändern und zu sehen, wer gespendet hat.
  • 🎚️ Ihre Entscheidung für jede Kampagne: Jede Peer-to-Peer-Kampagne kann die Standardeinstellung der Website übernehmen oder sie überschreiben, was wichtig ist, wenn eine Kampagne Spendenaktionen über Stripe Connect bezahlt und diese Personen ein Passwort benötigen.
  • 📋 Sehen Sie, wer noch nicht geklickt hat: Die Registerkarte Charitable » Ambassadors » Directory » Awaiting Sign-In listet alle auf, die noch warten, mit der Kampagne, der sie beigetreten sind, und einer Schaltfläche zum erneuten Senden, sodass Sie einen Tippfehler oder einen Spam-Ordner erkennen und beheben können.
  • 🛡️ Links, die ein Scanner nicht aufbrauchen kann: Das Öffnen des Links zeigt nur eine Seite an, und Ihr Spendenaktionsteilnehmer wird angemeldet, wenn er auf die Schaltfläche darauf klickt. Daher verbrennen E-Mail-Scanner von Unternehmen den Link nie. Jeder funktioniert einmal, läuft von selbst ab und wird nur als Hash gespeichert.

Lesen Sie hier unsere Ankündigung.

Botschafter Neu

🏃 Aktivität vorstellen: Fortschritt bei mehr als nur Geld anzeigen!

Bei den meisten Peer-to-Peer-Spendenaktionen geht es um mehr als nur Geld. Bei einem Lese-Marathon geht es um gelesene Minuten, bei einem Spendenlauf um gegangene Meilen und bei einer Lebensmittelspendenaktion um verpackte Mahlzeiten. Mit der Aktivität für Charitable Ambassadors können Ihre Spendenwerber diese Anstrengung direkt neben den gesammelten Dollar anzeigen. Warum das wichtig ist:

  • 🎯 Fortschritt bei dem, was Sie tatsächlich zählen: Ein Fortschrittsbalken zeigt jede Sache, die Sie zählen, gegen ihr eigenes Ziel an, direkt neben dem gesammelten Geld.
  • 🏅 Meilensteine für Ja-oder-Nein-Dinge: Eine Meilenstein-Plakette kennzeichnet Bemühungen, die einfach erledigt oder nicht erledigt sind, ohne eine Zahl, die es zu erreichen gilt.
  • ✍️ Spendenwerber protokollieren ihre eigenen Zahlen: Ihre Unterstützer geben ihre Summen von ihren eigenen Seiten ein, sodass die Anstrengung aufhört, in einer Tabelle, einem Kommentar oder gar nirgends zu leben.
  • 🤖 Einige Zahlen zählen sich selbst: Ein AUTOMATISCHES Tag erscheint überall dort, wo die Website die Zahl aus abgeschlossenen Spenden ermittelt hat, sodass Sie auf einen Blick sehen können, was niemand eingetippt hat.
  • 🧩 Einmal einrichten, überall verwenden: Sie entscheiden, was einmal gezählt wird, und wählen dann aus, welche Kampagnen es zählen. Jetzt verfügbar in Charitable Ambassadors 3.4.7, ohne neues Plugin und ohne Entwickler.

Lesen Sie hier unsere Ankündigung.

Botschafter Neu

🖨️ Wir stellen vor: Flyer und Poster: Sammeln Sie Geld abseits des Bildschirms!

Viele Spendenaktionen von Person zu Person finden abseits eines Bildschirms statt: an der Ziellinie eines 5-km-Laufs, an einer Schultafel, in einer Büchereiküche. Charitable Ambassadors 3.4.7 fügt 2 druckbare Elemente hinzu: einen Spenden-Flyer mit der eigenen Geschichte und dem QR-Code jedes Spendenwerbers und ein Rekrutierungsplakat, das neue Spendenwerber anmeldet. Beide lassen sich wie eine normale Webseite öffnen und direkt aus dem Browser ausdrucken. Warum das wichtig ist:

  • 🏁 Ein Flyer für jeden Spendenwerber: Jeder Flyer enthält das eigene Foto, die eigene Geschichte und das eigene Ziel des Spendenwerbers, mit einem QR-Code, der dessen Seite öffnet und nicht Ihre Hauptkampagne.
  • 📌 Ein Plakat, das rekrutiert: Es zeigt „Jetzt rekrutieren“ über Ihrem Kampagnennamen mit einem großen QR-Code, der Ihr Anmeldeformular öffnet, sodass jemand mit dem Spenden sammeln beginnen kann, ohne auf einen Link von Ihnen zu warten.
  • 🪄 Kein Design-Tool erforderlich: Beide Druckvorlagen werden als normale Webseite gerendert und aus dem Browser gedruckt, ohne PDF-Plugin und ohne Designer.
  • 📄 2 Flyer-Layouts: „Hand out“ enthält die vollständige Geschichte für Spenden an Freunde und Familie, und „Post up“ enthält einen kurzen Aufhänger mit 5 abnehmbaren Reitkarten für eine Pinnwand.
  • 🛡️ Ausgeschaltet, bis Sie es einschalten: Flyer bleiben nach dem Update deaktiviert, bis Sie sie unter Charitable » Ambassadors » Other » Fliers aktivieren, und nur der Eigentümer oder ein Administrator kann einen öffnen.

Lesen Sie hier unsere Ankündigung.

Verbesserung Zahlungen

💸 Einführung von gestaffelten Sätzen für Gebührenerleichterungen: Passen Sie die Anfrage an die Spende an!

Gebührenerleichterungen stellt Ihren Spendern beim Bezahlvorgang eine kurze Frage: Möchten Sie die Bearbeitungsgebühr für diese Spende übernehmen? Bisher wurde für jede Spende über ein Gateway ein einziger Satz verwendet, sodass für eine Spende von 10 $ und eine Spende von 500 $ derselbe Prozentsatz berechnet wurde. Gebührenerleichterungen 1.3.0 ermöglicht es Ihnen, beliebig viele Spendenbänder festzulegen, die jeweils ihren eigenen Satz haben. Warum das wichtig ist:

  • 🪙 Schonender bei kleinen Spenden: Eine feste Transaktionsgebühr macht einen weitaus größeren Anteil einer 10 $-Spende aus als einer 500 $-Spende. Bänder ermöglichen es Ihnen daher, am unteren Ende weniger zu verlangen.
  • 🎚️ So viele Bänder wie nötig: Jedes Band hat seinen eigenen Prozentsatz und seinen eigenen festen Betrag, und das oberste Band läuft ohne Obergrenze weiter.
  • 🛑 Eine optionale Obergrenze: Ein Feld für die maximale Gebühr verhindert, dass von einem Spender mehr als ein von Ihnen gewählter Betrag verlangt wird, egal wie hoch die Spende ist.
  • 🔌 Pro Zahlungs-Gateway einstellbar: Stripe kann mit vier Bändern laufen, während Windcave und Payfast mit einem einzigen Satz arbeiten, da Bänder zu einem Gateway und nicht zu Ihrer gesamten Website gehören.
  • 🛡️ Nichts ändert sich, bis Sie es sagen: Ihre aktuellen Sätze bleiben genau so, wie sie sind, bis Sie unter Charitable » Einstellungen » Erweitert » Gebührenerleichterungen die Option „Gestaffelte Sätze verwenden“ aktivieren.

Lesen Sie hier unsere Ankündigung.

Spenden Verbesserung

📊 Ihr Pro Dashboard kann jetzt vergleichen, exportieren und bewerten!

Die meisten Fundraising-Dashboards zeigen Ihnen nur, wie viel Sie eingenommen haben. Charitable Pro 1.8.19 baut das Dashboard und die Berichtsübersicht um die schwierigeren Fragen herum neu auf: ob etwas kaputt ist, ob diese Periode die letzte geschlagen hat und welche einzelne Änderung heute den größten Unterschied machen würde. Warum das wichtig ist:

  • 📈 Jede Zahl hat einen Trend: Wählen Sie eine Periode aus und die Kacheln und das Diagramm bewegen sich zusammen, wobei jede Summe im Vergleich zur Vorperiode angezeigt wird.
  • 🗓️ Lesbare Diagramme: Kurze Zeiträume gruppieren Spenden tageweise, während längere Zeiträume nach Woche oder Monat gruppieren, sodass ein volles Jahr als Kurve und nicht als flache Linie gelesen wird.
  • 🔀 Vergleichen Sie beliebige 2 Perioden: Nicht nur aufeinanderfolgende, sodass Sie fragen können, wie dieser Dezember im Vergleich zum letzten Dezember abgeschnitten hat. Das ist wichtig, da Fundraising saisonabhängig ist.
  • 📤 Fassen Sie die gesamte Zusammenfassung zusammen: Senden Sie die vollständige Übersicht als CSV oder PDF, bereit für ein Board-Paket oder einen Spenderbericht.
  • 🎯 Bewerten Sie Ihr Setup kostenlos: Lassen Sie Ihr Fundraising-Setup bewerten, damit die eine Änderung, die sich als Nächstes lohnt, diejenige ist, die Sie sehen können.

Lesen Sie hier unsere Ankündigung.