Hooks: Plugin-Werte auslesen und überschreiben

Wie in WordPress üblich, stellt auch wpSEO eine Schnittstelle nach “außen” bereit: sogenannte Hooks erlauben Lese- wie Schreibzugriffe auf freigegebene Plugin-Einstellungen und Funktionen. Auf Optionen und Werte kann somit beispielsweise aus dem Theme heraus zugegriffen werden, um eine gezielte Ausgabe der einzelnen Metadaten zu ermöglichen. Ebenso lassen sich versteckte Optionen nachträglich nach eigenem Ermessen steuern.

Der aktuelle Umfang der implementierten und verfügbaren Hooks:

Schreibrechte

• wpseo_set_meta
• wpseo_set_title
• wpseo_set_desc
• wpseo_set_keys
• wpseo_set_robots
• wpseo_set_desc_chars
• wpseo_set_noindex_age

Leserechte

• wpseo_the_meta
• wpseo_the_title
• wpseo_the_desc
• wpseo_the_keys
• wpseo_the_robots
• wpseo_the_canonical

SEO Monitor

• wpseo_set_monitor
• wpseo_google_rank
• wpseo_page_speed
• wpseo_alexa_rank
• wpseo_sistrix_index
• wpseo_xovi_ovi
• wpseo_seit_wert
• wpseo_feed_count
• wpseo_twitter_count

Nachfolgend sind verständliche Beispiele gelistet, die eine mögliche Nutzung der wpSEO Hooks im Theme verdeutlichen. Fachwissen wird vorausgesetzt.

wpseo_set_meta (Schreiben)

add_action('init', 'set_wpseo_meta');

function set_wpseo_meta() {
  if ( is_single(1) ) {
    apply_filters(
      'wpseo_set_meta',
      array(
        'title' => 'Neuer Titel',
        'desc' => 'Neue Description',
        'keys' => 'Neue, Keywords',
        'robots' => 'follow, index',
        'canonical' => 'http://neue.url'
      )
    );
  }
}

Beispiel: Benutzerdefinierte Artikel-Metadaten

wpseo_set_title (Lesen & Schreiben)

add_action('init', 'wpseo_set_title');

function wpseo_set_title() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_title',
       'wpseo_set_title_callback'
    );
  }
}

function wpseo_set_title_callback($input) {
  return 'Neuer Titel für einen Artikel';
}

Beispiel: Benutzerdefinierter Artikel-Titel

wpseo_set_desc (Lesen & Schreiben)

add_action('init', 'wpseo_set_desc');

function wpseo_set_desc() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_desc',
       'wpseo_set_desc_callback'
    );
  }
}

function wpseo_set_desc_callback($input) {
  return $input . ' - Erweiterte Description für einen Artikel.';
}

Beispiel: Benutzerdefinierte Artikel-Description

wpseo_set_keys (Lesen & Schreiben)

add_action('init', 'wpseo_set_keys');

function wpseo_set_keys() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_keys',
       'wpseo_set_keys_callback'
    );
  }
}

function wpseo_set_keys_callback($input) {
  return 'wpseo, wordpress, seo, plugin';
}

Beispiel: Benutzerdefinierte Artikel-Keywords

wpseo_set_robots (Lesen & Schreiben)

add_action('init', 'wpseo_set_robots');

function wpseo_set_robots() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_robots',
       'wpseo_set_robots_callback'
    );
  }
}

function wpseo_set_robots_callback($input) {
  return 'noindex, follow';
}

Beispiel: Benutzerdefinierter Robots-Wert

wpseo_set_desc_chars (Lesen & Schreiben)

add_action('init', 'wpseo_set_desc_chars');

function wpseo_set_desc_chars() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_desc_chars',
       'wpseo_set_desc_chars_callback'
    );
  }
}

function wpseo_set_desc_chars_callback($input) {
  return 100;
}

Beispiel: Benutzerdefinierter Wert für die Anzahl der Description-Zeichen

wpseo_set_noindex_age (Lesen & Schreiben)

add_action('init', 'wpseo_set_noindex_age');

function wpseo_set_noindex_age() {
  if ( is_single(1) ) {
    add_filter(
      'wpseo_set_noindex_age',
       'wpseo_set_noindex_age_callback'
    );
  }
}

function wpseo_set_noindex_age_callback($input) {
  return 3;
}

Beispiel: Benutzerdefinierter Wert für die Anzahl der Monate bei automatischem Setzen des Robots-Wertes auf noindex

Anmerkung
Es ist zu beachten, dass die fehlerfreie Arbeitsweise weiterer Hooks nur unter der Voraussetzung erfolgt, dass die Option Ausgabe der Metadaten im Template manuell anstoßen im Bereich “Geschwindigkeit” explizit ausgewählt ist.

wpseo_the_meta (Lesen)

do_action('wpseo_the_meta');

Ausgabe generierter Metadaten

wpseo_the_title (Lesen)

do_action('wpseo_the_title');

Ausgabe des generierten Titels

wpseo_the_desc (Lesen)

do_action('wpseo_the_desc');

Ausgabe der generierten Description

wpseo_the_keys (Lesen)

do_action('wpseo_the_keys');

Ausgabe generierter Keywords

wpseo_the_robots (Lesen)

do_action('wpseo_the_robots');

Ausgabe des generierten Robots-Wertes

wpseo_the_canonical (Lesen)

do_action('wpseo_the_canonical');

Ausgabe der generierten Canonical-URL

Zuletzt geändert am 27. März 2012