Filter: inx_special_query_vars

Eine Reihe von allgemeinen Variablen für die Abfrage und Darstellung von Kickstart-spezifischen Daten kann komponentenübergreifend definiert werden, bspw. per GET-Parameter (für alle betroffenen Komponenten einer Seite) oder Shortcode-Attribut (einzelne Komponenten). Die Namen dieser Variablen beginnen immer mit dem Präfix inx-, Beispiele:

  • inx-limit (max. Anzahl von Listenelementen)
  • inx-sort (Sortierschlüssel für Listenansichten)
  • inx-references (Berücksichtigung von Referenzobjekten)

Sollen zusätzliche Variablen dieser Art verfügbar gemacht werden, müssen diese über den o. g. Filter-Hook registriert werden.

?> Die Ergänzung solcher Variablen ist vor allem bei der Entwicklung von Add-ons relevant.

Parameter

Name (Typ)
$var_names (array)
$prefix (string)

Rückgabewert

erweiterte Liste von Variablennamen (ergänzte Angaben beginnen immer mit dem Wert des Parameters $prefix)

Rahmenfunktion

add_filter( 'inx_special_query_vars', 'mysite_extend_special_query_vars', 10, 2 );
function mysite_extend_special_query_vars( $var_names, $prefix ) {
    // Zwei allgemeine Variablen für Abfragen ergänzen.
    $var_names[] = "{$inx_prefix}agent";
    $var_names[] = "{$inx_prefix}primary-agent";
    return $var_names;
} // mysite_extend_special_query_vars