Spendenformulare können dank der internen API von Charitable auf verschiedene Weise angepasst werden. Eine der am häufigsten nachgefragten Funktionen ist das Hinzufügen eines oder mehrerer benutzerdefinierter Felder zum Charitable-Spendenformular. In diesem Beitrag zeigen wir Ihnen, wie Sie mit Charitable ein neues Feld – eine Textbox – zu Ihren Spendenformularen hinzufügen können.
Auch wenn Sie kein Entwickler sind, ist das Hinzufügen von Code-Snippets einfach. Sie haben die Möglichkeit, ein Code-Snippet-Plugin Ihrer Wahl zu installieren, aber da Charitable hervorragend mit WPCode funktioniert... gehen wir davon aus, dass Sie dieses für diesen Beitrag verwenden.
Hinweis: Wenn Sie Entwickler SIND, dann wissen Sie, dass Code-Snippets zur functions.php eines WordPress-Themes oder innerhalb eines eigenen Plugins hinzugefügt werden können... wenn Sie diesen Weg gehen, empfehlen wir Ihnen, unsere Anweisungen zu Best Practices für das Schreiben von Code mit Charitable zu befolgen. Sie sollten auch unsere Dokumentation zu Charitable_Donation_Field lesen.
WPCode verwenden
Der erste Schritt ist die Installation von WPCode selbst. Sie können die kostenlose Version genauso installieren und aktivieren, wie Sie es mit jedem anderen WordPress-Plugin tun können. Charitable verfügt jedoch über einen einfacheren integrierten Prozess. Bitte lesen Sie unsere Dokumentation zur Installation und zum Durchsuchen von Code-Snippets mit WPCode.
Code-Snippet-Bibliothek
Alle Code-Snippets, die wir in diesem Beitrag teilen werden, befinden sich in Charitables Code-Bibliothek bei WPCode. Sie müssen WPCode nicht verwenden, um die Code-Snippets und Beispiele in dieser Bibliothek zu nutzen... Sie können verschiedene Code-Beispiele Ihrer Wahl aus dem Plugin kopieren und in Ihren Texteditor oder eine andere Anwendung einfügen. Daher empfehlen wir Ihnen, zu bookmarken: Charitables Code-Bibliothek bei WPCode.
Hinzufügen eines Textfelds
In unserem ersten Beispiel beginnen wir mit einer einfachen Textbox zu unserem Spendenformular. Suchen Sie auf der Code-Snippet-Seite von Charitable im Plugin nach „Textbox“ oder kopieren Sie den folgenden Code und fügen Sie ihn in Ihren Code-Editor ein.
Dieser Code befindet sich hier in Charitables Code-Bibliothek bei WPCode.
/**
* Shows how to add a custom text box in a donation form.
* In this example, we are adding a text box to collect a special referral code that the admin can read later.
*
* This snippet only works in Charitable 1.5 or above.
*
*/
function wpchar_charitable_register_new_text_field() {
/**
* Define a new text field.
*/
if ( ! class_exists("Charitable_Donation_Field" ) ) {
return;
};
/* Create the Donation Field instance. */
$field = new Charitable_Donation_Field(
'my_custom_field',
array(
'label' => __( 'Referral Code' ), // what text shows up in the donation form.
'data_type' => 'meta',
'value_callback' => false,
'donation_form' => array(
'type' => 'text', // the type of field to show in the donation form (text, checkbox, etc.)
'required' => false, // whether the field is required.
'show_after' => 'phone', // the field to show this one after.
),
'admin_form' => true,
'show_in_meta' => true,
'show_in_export' => true,
'email_tag' => array( // the tag to use in email notifications (make false to not add this to tags.
'description' => __( 'The custom field value' ),
),
)
);
/* Register it. */
charitable()->donation_fields()->register_field( $field );
}
add_action( 'init', 'wpchar_charitable_register_new_text_field' );Hier sind die wichtigsten Felder zum Anpassen:
- Label. Ändern Sie den Text „Mein benutzerdefiniertes Feld“ in den Anführungszeichen in den Text, den Spender sehen sollen, wenn sie dieses Feld im öffentlichen Spendenformular sehen.
- donation_form -> type. Dies ist der Typ des Spendenfelds (Text, Auswahl, Kontrollkästchen, Datumsauswahl usw.). Siehe unsere Dokumentation für eine vollständige Liste der unterstützten Spendenfeldtypen.
- donation_form -> required. Wenn Sie möchten, dass dieses Feld erforderlich ist, setzen Sie es auf true.
- email_tag. Wenn Sie den in dieses Feld eingegebenen Wert in Ihrer E-Mail mit einem E-Mail-Tag in Charitable aufnehmen möchten, fügen Sie hier eine Beschreibung hinzu, damit Sie ihn in den E-Mail-Einstellungen sehen können. Standardmäßig verwendet Charitable den Schlüsselwert als Tag (in diesem Fall ‚my_custom_field‘).
Sobald dieser Code (über den Charitable-Snippet-Bildschirm oder durch Kopieren und Einfügen des Codes) in WPCode eingefügt wurde, stellen Sie sicher, dass Sie ihm einen beschreibenden Titel geben, dass der Code-Typ „PHP-Snippet“ ist und dass Sie Auto-Insert/Überall ausführen ausgewählt haben. Machen Sie das Snippet aktiv/aktiviert.
Sobald dies aktiv ist, besuchen Sie ein Spendenformular (entweder automatisch von Charitable generiert oder über einen Shortcode).
Sie sollten etwas Ähnliches sehen:
Glückwunsch! Sie haben Ihr Empfehlungscode-Textfeld hinzugefügt. 🎉
Benutzerdefinierte Daten in einer Spende anzeigen
Zur Erinnerung: Wenn Sie „admin_form“ in Ihrem Snippet auf true gesetzt haben, können Sie diese Informationen auf jedem Spenden-Bearbeitungsbildschirm anzeigen. Wenn „show_in_export“ im obigen Snippet auf true belassen wurde, sollten Sie diesen Wert auch in den CSV-Spenden-Daten in Charitable exportiert sehen.
Vorausschau
Wenn Sie Entwickler sind oder sich mit dem Hinzufügen des obigen Codes wohlfühlen, sollten Sie sich unsere Charitable_Donation_Field-Dokumentation und die Donation Fields API für zusätzliche und tiefere Anpassungen ansehen… und vergessen Sie nicht, die Code-Bibliothek von Charitable bei WPCode zu durchsuchen.
Bitte lassen Sie uns wissen, wenn Sie Beiträge oder Dokumentationen zu einem bestimmten Thema wünschen, und zögern Sie nicht, sich an den Support zu wenden! Wir würden uns über Feedback freuen!
Hinterlassen Sie eine Antwort