MemberMouse WordPress-Haken

Hooks are provided by WordPress to allow your plugin to ‘hook into’ the rest of WordPress; that is, to call functions in your plugin at specific times, and thereby set your plugin in motion. MemberMouse defines its own set of hooks that you can utilize to ‘hook into’ MemberMouse so you can call functions in your plugin when specific events occur in MemberMouse.

Here’s a basic example:

function memberAdded($data)
{
    // Aktion ausführen
}
add_action('mm_member_add', 'memberAdded');

In this example, we’re using the ‘add_action()‘ method to indicate that the ‘memberAdded() ‘method should be called when MemberMouse executes a ‘mm_member_add’ action. To learn more about working with WordPress’ Action API diesen Artikel lesen.

Kategorien von WordPress-Hooks

MemberMouse Action-Referenz

The following table lists all of the MemberMouse actions, a description of when they’re executed and what data will be passed to any function hooked into the action.

Aktion	Beschreibung	Übermittelte Daten
mm_member_add	Diese Aktion wird ausgeführt, wenn ein neues Mitglied zu MemberMouse hinzugefügt wird.	Mitgliederdaten
mm_member_membership_change	This action is executed when a member’s membership level is changed.	Mitgliederdaten
mm_member_status_change	This action is executed when the status of a member’s account changes.	Mitgliederdaten
mm_member_account_update	This action is executed when certain data on a member’s account is updated. Dazu gehören: Vorname, Nachname, E-Mail-Adresse, Nutzername, Telefonnummer, Notizen, Rechnungsadresse, Lieferadresse, Berechnungsmethode für Tage als Mitglied und benutzerdefinierte Felddaten.	Mitgliederdaten
mm_member_delete	This action is executed when a member’s account is deleted.	Mitgliederdaten
mm_bundles_add	This action is executed when a bundle is added to a member’s account.	Mitgliederdaten, Daten bündeln
mm_bundles_status_change	This action is executed when the status of a bundle changes on a member’s account.	Mitgliederdaten, Daten bündeln
mm_product_purchase	Diese Aktion wird bei der Übermittlung einer Bestellung vor der Validierung und Zahlung ausgeführt.	Mitgliederdaten, Bestelldaten
mm_Einkauf_vollständig	Diese Aktion wird ausgeführt, wenn ein Kauf abgeschlossen ist. Sie ist in MemberMouse 3.0.6 und neuer verfügbar.	Mitgliederdaten, Bestelldaten
mm_zahlungseingang_erhalten	Diese Aktion wird ausgeführt, wenn eine Zahlung eingegangen ist.	Mitgliederdaten, Bestelldaten
mm_Zahlung_Rechnung	Diese Aktion wird ausgeführt, wenn eine Nachzahlungszahlung eingeht.	Mitgliederdaten, Bestelldaten
mm_Zahlung_Rechnung_abgelehnt	Diese Aktion wird ausgeführt, wenn eine Rechnungszahlung abgelehnt wird.	Mitgliederdaten, Bestelldaten
mm_refund_issued	Diese Aktion wird ausgeführt, wenn eine Erstattung ausgestellt wird.	Mitgliederdaten, Bestelldaten
mm_provision_initial	Diese Aktion wird ausgeführt, wenn eine erste Affiliate-Provision verfolgt werden soll.	Partnerdaten
mm_provision_abrechnung	Diese Aktion wird ausgeführt, wenn eine Rebill-Affiliate-Provision nachverfolgt werden soll.	Partnerdaten
mm_commission_cancel	Diese Aktion wird ausgeführt, wenn eine Partnerprovision storniert werden soll.	Partnerdaten

Datenattribute nach Typ

Alle Daten werden als assoziatives Array an Funktionen übergeben und können wie folgt abgerufen werden:

$data["first_name"]
$data["last_name"]
$data["email"]

In den folgenden Abschnitten sind die für jeden Typ verfügbaren Datenattribute aufgeführt.

Daten der Mitglieder

Attribut	Beschreibung
mitglied_id	Die ID, die dem Mitglied von MemberMouse zugewiesen wurde.
registriert	Das Datum der Anmeldung des Mitglieds im Format JJJJ-MM-TT HH:MM:SS.
zuletzt_eingeloggt	Das Datum, an dem sich das Mitglied zuletzt angemeldet hat, im Format JJJJ-MM-TT HH:MM:SS.
zuletzt_aktualisiert	The date the member’s account was last updated in the format YYYY-MM-DD HH:MM:SS.
Tage_als_Mitglied	Die Anzahl der Tage, die das Mitglied bereits Mitglied ist.
Status	The status of the member’s account as an integer: 1 = active, 2 = canceled, 3 = locked, 4 = paused, 5 = overdue, 6 = pending activation, 7 = error, 8 = expired, 9 = pending cancellation
status_name	The status of the member’s account as a string (i.e. aktiv, gestrichen, usw.).
ist_komplimentär	This indicates if the member’s account is complimentary or not. It will be set to ‘true’ if the account is complimentary and ‘false’ if not.
mitgliedschaft_level	The ID of the membership level associated with the member’s account.
mitgliedschaft_level_name	The name of the membership level associated with the member’s account.
vor_name	The member’s first name.
letzter_name	The member’s last name.
Nutzername	The member’s username.
E-Mail	The member’s email address.
Telefon	The member’s phone number.
cf_#	Outputs the member’s value for the custom field with ID #. For example, if the ID of the custom field that stores birthday is 4 then to output the member’s birthday you would use ‘cf_4’.
rechnungs_adresse	The member’s billing address.
abrechnung_stadt	The member’s billing city.
rechnungs_Staat	The member’s billing state.
rechnungs_zip_code	The member’s billing zip code.
abrechnungs_land	The member’s billing country.
shipping_address	The member’s shipping address.
Versand_Stadt	The member’s shipping city.
versand_staat	The member’s shipping state.
versand_zip_code	The member’s shipping zip code.
shipping_country	The member’s shipping country.

Daten bündeln

Attribut	Beschreibung
bündel_id	Die ID des Bündels.
bundle_name	Der Name des Pakets.
tage_mit_bundle	The number of days the bundle has been active on the member’s account.
bundle_status	Der Status des Pakets: 1 = aktiv, 2 = storniert, 3 = gesperrt, 4 = pausiert, 5 = überfällig, 6 = ausstehende Aktivierung, 7 = Fehler, 8 = abgelaufen, 9 = ausstehende Stornierung
bundle_is_complimentary	This indicates if the bundle is complimentary or not. It will be set to ‘true’ if the bundle is complimentary and ‘false’ if not.
bundle_status_name	Der Status des Bündels als String (d.h. aktiv, gestrichen, usw.).
bundle_date_added	The date the bundle was added to the member’s account in the format YYYY-MM-DD HH:MM:SS.
bundle_last_updated	The date the bundle was last updated on the member’s account in the format YYYY-MM-DD HH:MM:SS.

Daten bestellen

Attribut	Beschreibung
auftrag_nummer	Die Referenznummer, die der Bestellung von MemberMouse zugewiesen wurde.
auftrag_transaktion_id	The transaction ID associated with the order. This can be used as a unique ID for all payments associated with an order. When a customer purchases a subscription, each rebill payment is part of the same order so they’ll all share the same order ID. Each rebill payment will have a unique transaction ID.
auftrag_gesamt	Der Gesamtbetrag der Bestellung, der gleich ist (Zwischensumme - Rabatt) + Versandkosten.
auftrag_zwischensumme	Die Zwischensumme der Bestellung.
auftrag_rabatt	Der auf die Bestellung angewandte Rabatt.
auftrag_versand	Die Versandkosten werden auf die Bestellung angerechnet.
bestell_versand_methode	Der Name der Versandart, die der Kunde beim Check-out gewählt hat.
auftrag_rechnung_adresse	Die mit der Bestellung verbundene Rechnungsadresse.
auftrag_rechnung_stadt	Der mit der Bestellung verbundene Rechnungsort.
auftrag_rechnung_staat	Der mit der Bestellung verbundene Abrechnungsstatus.
auftrag_rechnung_zip_code	Die mit der Bestellung verbundene Rechnungs-Postleitzahl.
auftrag_rechnung_land	Das mit der Bestellung verbundene Rechnungsland.
auftrag_versand_adresse	Die mit der Bestellung verbundene Lieferadresse.
auftrag_versand_stadt	Die mit der Bestellung verbundene Versandstadt.
auftrag_versand_staat	Der mit der Bestellung verbundene Versandstatus.
bestell_versand_zip_code	Die mit der Bestellung verbundene Postleitzahl für den Versand.
bestell_versand_land	Das mit der Bestellung verbundene Versandland.
produkte_bestellen	Eine Reihe von Produkten, die mit der Bestellung verbunden sind. Siehe die Produktdaten Tabelle unten die für jedes Produkt verfügbaren Parameter.
gutscheine_bestellen	Ein Array von Gutscheinen, die mit der Bestellung verbunden sind. Siehe die Kupon-Daten Tabelle unten für die Parameter, die für jeden Coupon verfügbar sind.
auftrag_prämien	Ein Array von Prorationen, die mit der Bestellung verbunden sind. Siehe die Verdichtungsdaten In der nachstehenden Tabelle finden Sie die für die einzelnen Aufteilungsposten verfügbaren Parameter.
auftrag_affiliate_id	Die mit der Bestellung verbundene Partner-ID.
auftrag_subaffiliate_id	Die mit der Bestellung verknüpfte Subaffiliate-ID.
auftrag_ip_adresse	Die mit dem Auftrag verbundene IP-Adresse.

Partnerdaten

Attribut	Beschreibung
auftrag_affiliate_id	Die mit der Bestellung verbundene Partner-ID.
auftrag_subaffiliate_id	Die mit der Bestellung verknüpfte Subaffiliate-ID.
mitglied_id	Die ID, die dem Mitglied von MemberMouse zugewiesen wurde.
auftrag_nummer	Die eindeutige Nummer der Bestellung in Verbindung mit der Transaktions-ID der Zahlung (z. B. 1456-3462). Dadurch wird sichergestellt, dass die hier angegebene Auftragsnummer für alle mit dem Auftrag verbundenen Abrechnungstransaktionen eindeutig ist.
auftrag_gesamt	Die für Provisionen verfügbare Auftragssumme, die der Auftragssumme abzüglich der Rabatte und Versandkosten entspricht.
auftrag_ip_adresse	Die mit dem Auftrag verbundene IP-Adresse.
produkte_bestellen	Eine Reihe von Produkten, die mit der Bestellung verbunden sind. Siehe die Produktdaten Tabelle unten die für jedes Produkt verfügbaren Parameter.
gutscheine_bestellen	Ein Array von Gutscheinen, die mit der Bestellung verbunden sind. Siehe die Kupon-Daten Tabelle unten für die Parameter, die für jeden Coupon verfügbar sind.
auftrag_prämien	Ein Array von Prorationen, die mit der Bestellung verbunden sind. Siehe die Verdichtungsdaten In der nachstehenden Tabelle finden Sie die für die einzelnen Aufteilungsposten verfügbaren Parameter.
rebill_commission_flat_rate	This will only be included on commission rebill events. Based on the commission profile applied to the order, this indicates if there’s a flat rate commission override that should be taken into account.
rebill_commission_percent	This will only be included on commission rebill events. Based on the commission profile applied to the order, this indicates if there’s a percentage commission override that should be taken into account.

Produktdaten

Product data is stored as an array of JSON-encoded objects in the ‘order_products’ attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_products"]);

This sample code assumes that the data was passed to your script in variable called ‘$data’. The table below outlines the available parameters for each item in the ‘order_products’ array.

Attribut	Beschreibung
id	Die ID des Produkts.
Name	Der Name des Produkts.
sku	Die SKU für das Produkt.
Betrag	Der für jede Einheit des Produkts gezahlte Betrag.
Menge	Die Nummer des gekauften Produkts.
insgesamt	Der gezahlte Gesamtpreis entspricht dem Betrag * Menge.
ist_wiederkehrend	Indicates where this product has a subscription associated with it or not. Possible values are ‘true’ or ‘false’.
wiederkehrender_Betrag	Der pro Abrechnungszeitraum gezahlte Betrag.
Abrechnungszeitraum	Eine ganze Zahl, die die Länge des Abrechnungszeitraums angibt. Um die vollständige Länge des Abrechnungszeitraums zu ermitteln, kombinieren Sie diesen Wert mit rebill_frequency (d. h. 1 Monat, 30 Tage, 2 Wochen usw.).
rebill_frequency	Eine Zeichenfolge, die die für den Abrechnungszeitraum verwendete Maßeinheit angibt. Mögliche Werte sind Tage, Wochen, Monate oder Jahre.

Kupon-Daten

Coupon data is stored as an array of JSON-encoded objects in the ‘order_coupons’ attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_coupons"]);

This sample code assumes that the data was passed to your script in variable called ‘$data’. The table below outlines the available parameters for each item in the ‘order_coupons’ array.

Attribut	Beschreibung
id	Die ID des Gutscheins.
Name	Der Name des Gutscheins.
Code	Der Gutscheincode.

Verdichtungsdaten

Proration data is stored as an array of JSON-encoded objects in the ‘order_prorations’ attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_prorations"]);

This sample code assumes that the data was passed to your script in variable called ‘$data’. The table below outlines the available parameters for each item in the ‘order_prorations’ array.

Attribut	Beschreibung
Betrag	Die Höhe des Anteils.
Beschreibung	Die mit dem Kauf verbundene Beschreibung.