Kulturletter und Abostatus in WordPress integrieren

Versandte Kulturletter und persönliche Newsletter-Abos sollen direkt im WordPress-Webauftritt zugänglich sein. Eine Mailchimp-API-Anbindung erstellt das Kampagnenarchiv und zeigt den Abostatus mehrerer Listen im Mitgliederprofil.

6 Min. von Matthias Ulrich
WordPress integriert Mailchimp-Kampagnen als Kulturletter-Archiv und zeigt den persönlichen Abostatus mehrerer Newsletterlisten.

Ein Kulturletter verbindet aktuelle Inhalte der Website mit der regelmässigen Kommunikation per E-Mail. Nach dem Versand bleiben die Ausgaben auch für spätere Besuche relevant. Gleichzeitig möchten angemeldete Mitglieder erkennen, welche Newsletter sie abonniert haben und welche weiteren Listen ihnen zur Verfügung stehen.

Für diese Aufgaben haben wir Mailchimp mit WordPress verbunden. Die Integration ruft versandte Kampagnen für ein automatisch aktualisiertes Kulturletter-Archiv ab. Im persönlichen Mitgliederprofil zeigt sie zusätzlich den Abostatus mehrerer Newsletterlisten und führt zum jeweiligen Anmeldeweg.

Versandte Kulturletter automatisch anzeigen

Mailchimp verwaltet jede versandte Ausgabe als Kampagne. Die Marketing API stellt deren Betreff, Versandzeitpunkt und öffentliche Archivadresse bereit. WordPress kann diese Angaben abrufen und daraus eine eigene Kulturletter-Übersicht erzeugen.

Die Anfrage beschränkt sich auf Kampagnen mit dem Status sent. Dadurch enthält die Übersicht die tatsächlich versandten Ausgaben. WordPress ordnet sie nach dem Versanddatum und zeigt die jüngste Kampagne zuerst.

function ud_get_mailchimp_campaigns() {
	if ( ! defined( 'MAILCHIMP_API_KEY' ) ) {
		return new WP_Error(
			'mailchimp_configuration',
			'Mailchimp-Verbindung konfigurieren.'
		);
	}

	$api_key    = MAILCHIMP_API_KEY;
	$separator  = strrpos( $api_key, '-' );
	$datacenter = substr( $api_key, $separator + 1 );

	$url = add_query_arg(
		array(
			'status' => 'sent',
			'count'  => 100,
		),
		'https://' . $datacenter . '.api.mailchimp.com/3.0/campaigns'
	);

	$response = wp_remote_get(
		$url,
		array(
			'headers' => array(
				'Authorization' => 'Basic ' . base64_encode(
					'wordpress:' . $api_key
				),
			),
		)
	);

	if ( is_wp_error( $response ) ) {
		return $response;
	}

	$status_code = wp_remote_retrieve_response_code( $response );

	if ( $status_code < 200 || $status_code >= 300 ) {
		return new WP_Error(
			'mailchimp_response',
			'Mailchimp-Antwort prüfen.'
		);
	}

	$data = json_decode(
		wp_remote_retrieve_body( $response ),
		true
	);

	return isset( $data['campaigns'] )
		? $data['campaigns']
		: array();
}

Der API-Schlüssel liegt dabei in der serverseitigen WordPress-Konfiguration. Das Datacenter steht als Endung im Schlüssel und bestimmt die Adresse des zuständigen Mailchimp-Servers.

Kampagnen als Kulturletter-Archiv ausgeben

Für die Übersicht benötigt WordPress aus jeder Kampagne drei Angaben:

  • den Betreff als Titel
  • den Versandzeitpunkt als Datum
  • die Archivadresse als Link zur vollständigen Ausgabe

Vor der Ausgabe werden die Kampagnen anhand von send_time sortiert. Der Betreff und die Archivadresse stammen direkt aus den Kampagnendaten.

function ud_render_kulturletter_archive() {
	$campaigns = ud_get_mailchimp_campaigns();

	if ( is_wp_error( $campaigns ) ) {
		return '<p>Der Kulturletter wird aktualisiert.</p>';
	}

	usort(
		$campaigns,
		function ( $first, $second ) {
			$first_date  = $first['send_time'] ?? '';
			$second_date = $second['send_time'] ?? '';

			return strcmp( $second_date, $first_date );
		}
	);

	$output = '<ul class="ud-kulturletter-archive">';

	foreach ( $campaigns as $campaign ) {
		$title = $campaign['settings']['subject_line'] ?? '';
		$url   = $campaign['archive_url'] ?? '';
		$date  = $campaign['send_time'] ?? '';

		if ( empty( $title ) || empty( $url ) ) {
			continue;
		}

		$output .= '<li class="ud-kulturletter-archive__item">';
		$output .= '<a href="' . esc_url( $url ) . '">';
		$output .= esc_html( $title );
		$output .= '</a>';

		if ( $date ) {
			$output .= '<time datetime="' . esc_attr( $date ) . '">';
			$output .= esc_html(
				wp_date( 'j. F Y', strtotime( $date ) )
			);
			$output .= '</time>';
		}

		$output .= '</li>';
	}

	$output .= '</ul>';

	return $output;
}

add_shortcode(
	'kulturletter_archiv',
	'ud_render_kulturletter_archive'
);

Der Shortcode [kulturletter_archiv] setzt die Übersicht an der gewünschten Stelle ein. Neue Ausgaben erscheinen dort über dieselbe Datenquelle, aus der Mailchimp das öffentliche Kampagnenarchiv bereitstellt.

Falls mehrere Newsletter über dasselbe Mailchimp-Konto versendet werden, kann die Abfrage zusätzlich einen Begriff im Betreff berücksichtigen. Damit erhält beispielsweise der Kulturletter eine eigene Übersicht, während andere Kampagnen weiterhin im gemeinsamen Konto verwaltet werden.

Mailchimp-Kampagnen werden als geordnetes Newsletterarchiv in WordPress bereitgestellt.
Aus einzelnen Kampagnen entsteht in WordPress ein fortlaufend geordnetes Kulturletter-Archiv.

Persönlichen Abostatus im Mitgliederprofil anzeigen

Das Kampagnenarchiv ist öffentlich zugänglich. Der persönliche Abostatus gehört zum angemeldeten Bereich, weil er sich auf die E-Mail-Adresse eines konkreten WordPress-Kontos bezieht.

WordPress liest die hinterlegte Adresse des aktuellen Mitglieds aus. Für die Anfrage an Mailchimp wird daraus ein Subscriber Hash erzeugt. Dieser Hash bildet zusammen mit der Listen-ID die Adresse, über die Mailchimp den Kontakt innerhalb einer Newsletterliste zuordnet.

function ud_get_mailchimp_subscription_status( $list_id ) {
	if ( ! is_user_logged_in() ) {
		return new WP_Error(
			'authentication',
			'Anmeldung erforderlich.'
		);
	}

	$user  = wp_get_current_user();
	$email = sanitize_email( $user->user_email );

	$subscriber_hash = md5(
		strtolower( trim( $email ) )
	);

	$api_key    = MAILCHIMP_API_KEY;
	$separator  = strrpos( $api_key, '-' );
	$datacenter = substr( $api_key, $separator + 1 );

	$url = sprintf(
		'https://%1$s.api.mailchimp.com/3.0/lists/%2$s/members/%3$s',
		rawurlencode( $datacenter ),
		rawurlencode( $list_id ),
		rawurlencode( $subscriber_hash )
	);

	$response = wp_remote_get(
		$url,
		array(
			'headers' => array(
				'Authorization' => 'Basic ' . base64_encode(
					'wordpress:' . $api_key
				),
			),
		)
	);

	if ( is_wp_error( $response ) ) {
		return $response;
	}

	$data = json_decode(
		wp_remote_retrieve_body( $response ),
		true
	);

	return $data['status'] ?? 'available';
}

Die Mailchimp Marketing API stellt den Kontakt über den Endpunkt /lists/{list_id}/members/{subscriber_hash} bereit. Er liefert unter anderem den aktuellen Status innerhalb der jeweiligen Liste.

Mehrere Newsletterlisten gemeinsam verwalten

Ein Mitglied kann mehreren Listen zugeordnet sein. Beim ISSV betrifft dies beispielsweise den Kulturletter und weitere Vereinsinformationen. Jede Liste besitzt eine eigene Mailchimp-ID und einen eigenen Anmeldeweg.

Die Konfiguration verbindet deshalb drei Angaben:

AngabeAufgabe
Listen-IDOrdnet die Anfrage der richtigen Mailchimp-Liste zu
TitelBezeichnet den Newsletter im Mitgliederprofil
AnmeldewegFührt zur passenden Anmeldung oder erneuten Anmeldung

WordPress durchläuft diese Konfiguration und fragt den Status jeder Liste separat ab:

$newsletter_lists = array(
	array(
		'id'            => 'LIST_ID_KULTURLETTER',
		'title'         => 'Kulturletter',
		'subscribe_url' => '/kulturletter-abonnieren/',
	),
	array(
		'id'            => 'LIST_ID_VEREINSNEWS',
		'title'         => 'Vereinsinformationen',
		'subscribe_url' => '/vereinsinformationen-abonnieren/',
	),
);

foreach ( $newsletter_lists as $newsletter ) {
	$status = ud_get_mailchimp_subscription_status(
		$newsletter['id']
	);

	// Status und passende Handlung ausgeben.
}

Die Listen bleiben technisch voneinander getrennt und erscheinen im Profil als zusammengehöriger Bereich. Weitere Newsletter können später mit derselben Struktur ergänzt werden.

Abostatus und nächste Handlung verbinden

Mailchimp unterscheidet mehrere Zustände. Die WordPress-Oberfläche übersetzt sie in verständliche Angaben und bietet jeweils den passenden nächsten Schritt an.

Mailchimp-StatusAnzeige im ProfilHandlung
subscribedAbonniertDer aktuelle Status bleibt sichtbar
unsubscribedAbbestelltErneut abonnieren
archivedArchiviertZur Anmeldung
Kontakt verfügbarZur Anmeldung verfügbarAbonnieren

Die Zuordnung verbindet Information und Handlung direkt miteinander. Mitglieder erkennen den aktuellen Stand jeder Liste und gelangen von dort zum vorgesehenen Anmeldeablauf.

Das WordPress-Profil zeigt den persönlichen Abostatus mehrerer Mailchimp-Newsletterlisten.
Mehrere Newsletterlisten und ihr jeweiliger Abostatus sind direkt im persönlichen Profil sichtbar.

Kulturletter und Mitgliederverwaltung gemeinsam entwickeln

Auf der WordPress-Plattform des ISSV ist die Newsletterintegration Teil einer umfassenderen Inhalts- und Mitgliederverwaltung. Versandte Ausgaben bilden ein automatisch gepflegtes Kulturletter-Archiv. Angemeldete Mitglieder sehen den persönlichen Abostatus ihrer Newsletterlisten direkt im Profil.

API-Anfragen zuverlässig verarbeiten

Der API-Zugriff findet auf dem Server statt. Der Mailchimp-Schlüssel bleibt in der WordPress-Konfiguration und gelangt weder in den Seiteninhalt noch in ein Frontend-Skript.

Vor jeder persönlichen Statusabfrage prüft WordPress die Anmeldung. Die E-Mail-Adresse stammt aus dem aktuellen WordPress-Konto und wird für die Mailchimp-Zuordnung vereinheitlicht. Listen-IDs, URLs und Ausgabewerte werden entsprechend ihrem Datentyp verarbeitet und bereinigt.

Auch die Antwort der API wird vor ihrer Verwendung geprüft. Ein erfolgreicher HTTP-Status führt zur gewünschten Ausgabe. Verbindungs- und Konfigurationszustände erhalten eine verständliche Rückmeldung für die Website.

Bei häufig aufgerufenen Profilen kann WordPress die ermittelten Statuswerte vorübergehend als Transient speichern. Der Schlüssel kombiniert Benutzer, Newsletterliste und Funktion. Nach Ablauf des vorgesehenen Zeitraums wird der Status erneut bei Mailchimp abgerufen.

Ergebnis

Kulturletter und Abos verbinden

Die Mailchimp-Anbindung führt versandte Kampagnen und persönliche Abonnementdaten im WordPress-Webauftritt zusammen.

Das Kulturletter-Archiv aktualisiert sich aus den vorhandenen Kampagnen, während angemeldete Mitglieder den Status mehrerer Newsletterlisten direkt im Profil sehen.

Kampagnen automatisch anzeigen

Versandte Ausgaben erscheinen mit Betreff, Datum und Archivlink im Webauftritt.

Abostatus persönlich zuordnen

Das Mitgliederprofil ordnet jede Newsletterliste der hinterlegten E-Mail-Adresse zu.

Mehrere Listen gemeinsam verwalten

Jede Liste erhält einen eigenen Status und den passenden Weg zur Anmeldung.