Bitte beachten Sie: Diese Dokumentation ist noch nicht vollständig und deckt noch nicht alle Filter & Action Hooks ab, die in Charitable Ambassadors verfügbar sind. Wenn Sie keinen Hook oder Filter finden, der beschreibt, was Sie tun müssen, kontaktieren Sie uns bitte über unsere Support-Seite und wir helfen Ihnen gerne weiter.
Filter
Spendenaktion Botschafter Titel
Hinzugefügt in Version 2.0.0
Ändern Sie den automatisch generierten Titel für eine neue Spendenaktion, wenn der Titel dynamisch auf dem Namen des Kampagnenerstellers basiert.
Rückgabewert
String. Der Titel der Spendenaktion.
Argumente
$title (Zeichenkette)Der Titel. Standardmäßig ist dies der vollständige Name des Kampagnenerstellers.
$data (Array)Die übermittelten Daten.
Nutzung
add_filter( 'charitable_ambassadors_fundraiser_title', function( $title, $data ) {n $first_name = array_key_exists( 'first_name', $data ) ? $data['first_name'] : '';n $last_name = array_key_exists( 'last_name', $data ) ? $data['last_name'] : '';n $full_name = trim( sprintf( '%s %s', $first_name, $last_name ) );nn // Joe Blow's Fundraisern return sprintf( u0022%s's Fundraiseru0022, $full_name );n}, 10, 2 );
Botschafter Spendenaktion Meine Kampagnen Link zur Kampagnenerstellung anzeigen
Hinzugefügt in Version 2.0.0
Wählen Sie, ob Sie die Schaltfläche "Neue Kampagne erstellen" am Ende der Ausgabe des [charitable_my_campaigns] Shortcodes anzeigen möchten.
Rückgabewert
Boolean. True, wenn Sie sie anzeigen möchten, oder false, wenn Sie es vorziehen, dies nicht zu tun. Standardmäßig wird hier true zurückgegeben.
Argumente
$anzeigen (boolean)Ob die Schaltfläche angezeigt werden soll.
Nutzung
// Do not show the button.nadd_filter( 'charitable_ambassadors_my_campaigns_show_campaign_creation_link', '__return_false' );
Botschafter Spendenaktion Meine Kampagnen Schaltflächentext
Hinzugefügt in Version 1.0.0
Ändern Sie den Text der Schaltfläche "Kampagne erstellen" am Ende des [charitable_my_campaigns] Shortcodes.
Rückgabewert
String. Der Text, der in der Schaltfläche verwendet werden soll.
Argumente
$text (Zeichenkette)Der Schaltflächentext.
Nutzung
add_filter( 'charitable_ambassadors_my_campaigns_button_text', function( $text ) {n return 'Start a New Campaign';n} );
Permalink der Spendenaktion Seite für erfolgreiche Einreichung
Hinzugefügt in Version 1.0.0
Ändern Sie die Seite, zu der Benutzer weitergeleitet werden, nachdem sie ihre Kampagne zum ersten Mal eingereicht haben. Beachten Sie, dass Sie, wenn Sie zu einer statischen Seite weiterleiten möchten, dies ohne Code tun können, indem Sie die Einstellung "Erfolgsseite für Kampagneneinreichung" unter Charitable > Einstellungen > Botschafter konfigurieren.
Rückgabewert
String. Eine URL, zu der nach der ersten Einreichung einer Kampagne weitergeleitet werden soll. Beachten Sie, dass die Weiterleitung über einen Aufruf von `wp_safe_redirect()` erfolgt, sodass die URL zu einem erlaubten Host führen sollte (siehe https://developer.wordpress.org/reference/functions/wp_safe_redirect/).
Argumente
$standard (Zeichenkette)Die URL, zu der weitergeleitet werden soll.
$args (Array)Ein Array von Argumenten. Standardmäßig enthält dies nur eine `campaign_id`-Eigenschaft mit der ID der neu eingereichten Kampagne.
Nutzung
// Redirect to the newly submitted campaign after submission.nadd_filter( 'charitable_permalink_campaign_submission_success_page', function( $url, $args = array() ) {n if ( ! array_key_exists( 'campaign_id', $args ) ) {n return $url;n }nn return get_permalink( $args['campaign_id'] );n}, 10, 2 );
URL zur Umleitung nach Einreichung der Spendenaktion
Hinzugefügt in Version 1.0.0
Ändern Sie die URL, zu der Benutzer weitergeleitet werden, nachdem sie ihre Kampagne eingereicht, aktualisiert oder gespeichert und in der Vorschau angezeigt haben. Wenn Sie nur die Seite ändern möchten, zu der Benutzer nach der ersten Einreichung ihrer Kampagne weitergeleitet werden, verwenden Sie stattdessen den Filter `charitable_permalink_campaign_submission_success_page`.
Rückgabewert
u003cpu003eString. Die URL, zu der der Benutzer weitergeleitet wird.u003c/pu003e
Argumente
$url (Zeichenkette)u003cpu003eDie URL, zu der der Benutzer weitergeleitet wird.u003c/pu003e
$data (Array)Die übermittelten Daten.
$kampagnen_id (int)u003cpu003eDie Kampagnen-ID.u003c/pu003e
$benutzer_id (int)u003cpu003eDie Benutzer-ID.u003c/pu003e
Botschafter Spendenaktion Formular Zielliste
Hinzugefügt in Version 2.1.0
u003cpu003eFelder zum Spendenformular hinzufügen oder entfernen. u003c/pu003eu003cpu003eDie Feldliste ist eine Liste von Schlüsseln von Feldern, die im Hauptkampagnenformular enthalten sind und die auch im Spendenformular enthalten sein sollten. Die folgenden Felder sind standardmäßig nicht im Spendenformular enthalten:u003c/pu003eu003cpu003e- u003ccodeu003edescriptionu003c/codeu003eu003cbru003e- u003ccodeu003ecategoriesu003c/codeu003eu003cbru003e- u003ccodeu003etagsu003c/codeu003eu003cbru003e- u003ccodeu003esuggested_donationsu003c/codeu003eu003cbru003e- u003ccodeu003eallow_custom_donationsu003c/codeu003eu003c/pu003e
Rückgabewert
array
Argumente
$liste (array)u003cpu003eDie Liste der einzuschließenden Felder.u003c/pu003e
$formular (Charitable_Ambassadors_Fundraiser_Form)u003cpu003eDas Spendenformularobjekt.u003c/pu003e
Nutzung
// Include the 'description' field in the Fundraiser form.nadd_filter( 'charitable_ambassadors_fundraiser_form_field_list', function( $fields ) {n $fields[] = 'description';n return $fields;n} );
Botschafter Spendenaktion Vererbte Felder
Hinzugefügt in Version 2.0.0
u003cpu003eFiltert die Felder, die automatisch von der übergeordneten Kampagne des Spendenprojekts übernommen werden.u003c/pu003e
Rückgabewert
array
Argumente
$fields (Array)u003cpu003eDie übernommenen Felder.u003c/pu003e
Nutzung
add_filter(n 'charitable_ambassadors_fundraiser_inherited_fields', n function( $fields ) {n $fields[] = 'my_custom_field';n return $fields;n }n);
Botschafter Spendenaktion Enddaten der Spendenaktion beim Ändern des übergeordneten Enddatums aktualisieren
Hinzugefügt in Version 2.0.0
u003cpu003eLegt fest, ob die Enddaten von Spendenaktionen automatisch aktualisiert werden sollen, wenn sich das Enddatum einer übergeordneten Kampagne ändert.u003c/pu003e
Rückgabewert
u003cpu003eBoolean. Standardmäßig true.u003c/pu003e
Argumente
$soll_aktualisiert_werden (boolean)u003cpu003eOb automatisch aktualisiert werden soll.u003c/pu003e
$campaign (Charitable_Campaign)u003cpu003eDas übergeordnete Kampagnenobjekt.u003c/pu003e
Botschafter Spendenaktion Spenden des Erstellers Exportspalten
Hinzugefügt in Version 2.0.0
u003cpu003eFiltert die Spalten, die im Export enthalten sind.u003c/pu003e
Rückgabewert
u003cpu003eArray. Die Schlüssel der einzuschließenden Spalten.u003c/pu003e
Argumente
$spalten (array)u003cpu003eDie einzuschließenden Spalten.u003c/pu003e
Nutzung
add_filter( 'charitable_ambassadors_creator_donations_export_columns', function( $columns ) {n // Only show the first name, last name, amount and donor comment.n $included_columns = array(n 'first_name',n 'last_name',n 'amount',n 'donor_comment',n );ntn foreach ( $columns as $column =u003e $header ) {n if ( ! in_array( $column, $included_columns ) ) {n unset( $columns[ $column ] );n }n }ntn return $columns;n} );





