Skip to content

Entwicklerhinweise

FG DocCheck WP stellt im aktuellen Code keine eigenen WordPress Actions oder Filter als Erweiterungs-API bereit. Es registriert auch keine REST-Endpunkte, AJAX-Endpunkte, Cronjobs oder WP-CLI-Kommandos.

Die relevanten Integrationspunkte sind der Shortcode, zwei Konfigurationskonstanten, Query-Parameter sowie die gespeicherten WordPress- und Session-Daten.

Typ: WordPress Shortcode

Verwendung:

[fg_doccheck_login]

Der Shortcode besitzt keine dokumentierten Attribute. Er rendert den DocCheck-Login und optional den Gastzugang.

Ist bereits ein gültiger DocCheck- oder Gast-Status vorhanden, leitet der Shortcode zum angeforderten Redirect-Ziel weiter.

Typ: PHP-Konstante

Überschreibt die gespeicherte Client-ID zur Laufzeit.

define('FG_DOCCHECK_CLIENT_ID', '...');

Typ: PHP-Konstante

Überschreibt das gespeicherte Client-Secret zur Laufzeit.

define('FG_DOCCHECK_CLIENT_SECRET', '...');

Wird von der Schutzlogik an die Restricted-Login-Seite angehängt und vom Shortcode als gewünschtes Ziel ausgewertet.

Alternativer, ebenfalls vom Shortcode akzeptierter Name für das gewünschte Redirect-Ziel.

Wird für den optionalen inhaltsbezogenen Secure-Deeplink-Bypass verwendet.

Wenn der Parameter vorhanden ist, entfernt das Plugin die eigenen Authentifizierungswerte aus der PHP-Session und leitet auf die URL ohne den Parameter zurück.

Werden beim DocCheck-OAuth2-Callback verarbeitet. state verweist auf einen temporär gespeicherten Redirect-Datensatz.

fg_doccheck_wp_options

Die Option enthält die globalen Plugin-Einstellungen. Direkte Änderungen an der Option umgehen die Sanitizing-Logik der Settings API und sind deshalb nicht die bevorzugte Konfigurationsmethode.

_fg_doccheck_restricted
doccheck_temp
doccheck_temp_string

Die letzten beiden Namen werden laut Code bewusst für die Kompatibilität mit einer älteren Implementierung beibehalten.

fg_doccheck_auth
fg_doccheck_user
fggastlogin

fggastlogin wird laut Code bewusst als bestehender Schlüsselname weiterverwendet.

OAuth-State-Daten werden unter dynamischen Schlüsseln gespeichert:

fg_doccheck_state_<zufälliger Schlüssel>

Die Laufzeit beträgt 15 Minuten. Beim Verarbeiten eines States wird der zugehörige Transient gelöscht.

Die folgenden Hooks werden vom Plugin intern registriert. Sie sind keine vom Plugin bereitgestellten Extension Hooks:

WordPress-Hook Callback Priorität/Zweck
init start_session Priorität 1, PHP-Session starten
init handle_guest_logout Gast-/DocCheck-Logout verarbeiten
admin_menu register_settings_page Einstellungsseite registrieren
admin_init register_settings Settings API registrieren
add_meta_boxes add_meta_box Schutz-Meta-Box registrieren
save_post save_meta_box Meta-Box-Werte speichern
template_redirect handle_doccheck_callback Priorität 0, OAuth2-Callback verarbeiten
template_redirect protect_pages Priorität 1, Frontend-Zugriff prüfen

FG DocCheck WP registriert keine REST-Routen und keine REST-Berechtigungsfilter.

FG DocCheck WP registriert keine wp_ajax_*- oder wp_ajax_nopriv_*-Handler. Die Frontend-Schutzprüfung überspringt Requests, für die wp_doing_ajax() wahr ist.

Im aktuellen Projekt sind weder Cronjobs noch WP-CLI-Kommandos vorhanden.