Für Sie als Entwickler kann es wichtig sein, das Plugin nahtlos zu integrieren. Um diesen Prozess zu erleichtern, bietet es eine Reihe von leistungsstarken und flexiblen API-Funktionen (Application Programming Interface). Die API dient als Brücke zwischen Ihrer Anwendung und dem Multisite Language Switcher und bietet eine standardisierte Möglichkeit, mit seinen Funktionen zu interagieren und sie zu bearbeiten.
Diese Seite wird Sie durch die verfügbaren Funktionen führen.
Die Ausgabe des Plugins nutzen
Die Ausgabe des Plugins kann mit Hilfe der Funktion get_the_msls() erstellt werden. Die Funktion gibt die gleiche Zeichenkette zurück wie der Shortcode des Plugins.
/**
* Get the output or just use it as shortcode [sc_msls]
*
* @param mixed $attr
* @return string
*/
get_the_msls( $attr ): string;Der Parameter $attr wird intern in ein Array umgewandelt. Er kann verwendet werden, um zu überschreiben, was derzeit in den Optionen des Plugins eingestellt ist. Es gibt 4 Elemente, die durch Übergabe eines öffnenden oder schließenden HTML-Tags überschrieben werden können:
$attr = [
'before_item' => '',
'after_item' => '',
'before_output' => '',
'after_output' => '',
];Es gibt auch eine Funktion, die wie get_the_msls() funktioniert, aber die Ausgabe direkt ausgibt:
/**
* Output the links to the translations in your template
*
* You can call this function directly like that
*
* if ( function_exists ( 'the_msls' ) )
* the_msls();
*
* @uses get_the_msls
* @param string[] $arr
*/
the_msls( array $arr = [] ): void;Diese Funktion erwartet, dass $attr vom Typ Array ist.
Interaktion mit der Blog Collection
Der Multisite Language Switcher verbindet Websites miteinander und verwaltet sie mittels einer MslsBlogCollection-Instanz:
/**
* Gets the MslsBlogCollection instance
*
* @return \lloc\Msls\MslsBlogCollection
*/
msls_blog_collection(): \lloc\Msls\MslsBlogCollection;Eine Blog Collection ist im Grunde ein Objekt, das ein Array von MslsBlog-Objekten enthält. Diese Art von Objekt ist eine erweiterte Form der WordPress-Blog-Objekte, die als \StdClass bereitgestellt werden.
Sie können jedes Blog der Blog Collection abrufen, indem Sie der Funktion msls_blog ein Gebietsschema (Locale) übergeben:
/**
* Gets a blog by locale
*
* @param string $locale
*
* @return \lloc\Msls\MslsBlog|null
*/
msls_blog( string $locale ): ?\lloc\Msls\MslsBlog;Die Funktion gibt null zurück, wenn $locale in der Blog Collection nicht vorhanden ist.
Helper Funktionen
Es gibt einige API-Funktionen, mit denen sich bestimmte Informationen sehr einfach abrufen lassen.
Flag Icons abfragen
Sie können die URL eines Flaggensymbols erhalten, indem Sie ein Gebietsschema angeben. Dies sollte für jedes vorhandene Gebietsschema (Locale) funktionieren, ohne in die Blog Collection zu schauen.
/**
* Gets the URL of the country flag-icon for a specific locale
*
* @param string $locale
*
* @return string
*/
function get_msls_flag_url( string $locale ): string;Blog Beschreibung abfragen
Die folgende Funktion gibt die Blog-Beschreibung zurück, die in den Optionen des Plugins gespeichert ist. Sie verwendet die Blog Collection und kann daher fehlschlagen, wenn ein bestimmtes Gebietsschema (Locale) nicht existiert. Sie gibt in jedem Fall eine Zeichenkette zurück und stellt daher einen Parameter $default zur Verfügung, um etwas Raum für Anpassungen zu geben.
/**
* Gets description for a blog with a given locale
*
* @param string $locale
* @param string $default
*
* @return string
*/
get_msls_blog_description( string $locale, string $default = '' ): string;Permalink eines Blogs abfragen
Die folgende Funktion gibt den Permalink für eine Übersetzung des aktuellen Inhalts zurück. Sie verwendet die Blog-Sammlung wie die obige Funktion und gibt die für $default festgelegte Zeichenfolge zurück, falls sie fehlschlägt.
/**
* Gets permalink for a translation of the current post in a given locale
*
* @param string $locale
* @param string $default
*
* @return string
*/
get_msls_permalink( string $locale, string $default = '' ): string;Der Artikel ist auch in English verfügbar.