Hooks

Hooks erlauben es dem Nutzer, den Funktionsumfang eines WordPress-Plugins zu erweitern. Nachfolgende Hooks sind in Statify hinterlegt und lassen sich via Code ansprechen bzw. steuern:

statify__skip_tracking

Typ: Filter (Boolean)
Implementierung: Statify 1.2.6

Benutzerdefinierte Steuerung der Zählung von Seitenaufrufen abhängig z.B. vom Seitentyp, Nutzerrechten, Browsertyp. Auf diese Weise lassen sich alle oder bestimmte Blogseiten von der Zählung ausschließen.

Der Hook erhält einen (optionalen) Parameter, welcher das Ergebnis vorhergehender Filter (falls vorhanden) enthält. Der erste benutzerdefinierte Filter erhält immer null.

Es gibt drei mögliche Rückgabewerte:

  • true – Statify berücksichtigt die aktuell aufgerufene Blogseite nicht
  • false – Statify berücksichtigt die aktuelle Anfrage ohne eingebaute Filter auszuwerten
  • null – kann als „keine Entscheidung“ interpretiert werden, Statify wird mit der Auswertung eingebauter Filter fortfahren

Exemplarischer Code:

add_filter(
    'statify__skip_tracking',
    function( $previous_result ) {
        if ( 1 === 1 ) {
            return true;
        }
	
        return false;
    }
);Code-Sprache: PHP (php)

statify__user_can_see_stats

Typ: Filter (Boolean)
Implementierung: Statify 1.3.1

Anzeigesteuerung der Dashboard-Statistiken für Nicht-Administratoren. Der Zugriff auf das Dashboard-Widget mit WordPress-Statistiken kann punktuell pro Nutzer oder Nutzergruppe gewährt werden.

Der Rückgabewert true erlaubt den Zugang zur Statistik. Das Bearbeiten der Plugin-Einstellungen im Widget bleibt weiterhin ausschließlich Anwendern mit der Benutzerrolle edit_dashboard vorbehalten.

Exemplarischer Code:

add_filter( 'statify__user_can_see_stats', '__return_true' );Code-Sprache: PHP (php)

Spezifisch für Redakteure:

add_filter(add_filter(
    'statify__user_can_see_stats',
    function( $previous ) {
        return $previous || current_user_can( 'edit_others_pages' );
    }
);Code-Sprache: PHP (php)

Mehr Rollen und deren Rechte findest du im Codex.


statify__visit_saved

Typ: Action
Implementierung: Statify 1.6.0

Dieser Action Hook wird ausgelöst, nachdem Statify einen Besuch in der Datenbank gespeichert hat. Er ist für weiterführende Verarbeitung oder Erweiterung des Ergebnisses konzipiert.

Der Hook erhält bis zu zwei Parameter:

  • array $data – assoziatives Array mit den drei Felden, die in die Datenbank eingefügt wurden:
    • created – Datum des Besuchs als String im YYYY-MM-DD Format
    • referrer – die Referrer URL
    • target – die Zielseite (relative URL)
  • int $id – ID des Eintrages in der Tabelle wp_statify

Exemplarischer Code:

add_action(
    'statify__visit_saved',
    function( $data, $id ) {
        /*
         * Do custom stuff...
         *
         * $data = array(
         *   'created'  => '2020-05-20',
         *   'referrer' => 'https://pluginkollektiv.org/',
         *   'target`   => '/'
         * )
         *
         * $id = 42
         */
    },
    10,
    2
);Code-Sprache: PHP (php)