{"id":654,"date":"2024-06-19T15:16:05","date_gmt":"2024-06-19T15:16:05","guid":{"rendered":"https:\/\/msls.co\/de\/?page_id=654"},"modified":"2025-10-13T15:29:55","modified_gmt":"2025-10-13T15:29:55","slug":"api-funktionen","status":"publish","type":"page","link":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/","title":{"rendered":"API Funktionen"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">F\u00fcr 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\u00fccke zwischen Ihrer Anwendung und dem <a href=\"https:\/\/msls.co\/de\/\">Multisite Language Switcher<\/a> und bietet eine standardisierte M\u00f6glichkeit, mit seinen Funktionen zu interagieren und sie zu bearbeiten.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Diese Seite wird Sie durch die verf\u00fcgbaren Funktionen f\u00fchren.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"get_the_msls\">Die Ausgabe des Plugins nutzen<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Die Ausgabe des Plugins kann mithilfe der Funktion <code>get_the_msls()<\/code> erstellt werden. Diese gibt die gleiche Zeichenkette zur\u00fcck wie der Shortcode des Plugins.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Get the output or just use it as shortcode &#91;sc_msls]\n *\n * @param mixed $attr\n * @return string\n *\/\nget_the_msls( $attr ): string;<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Der Parameter <code>$attr<\/code> wird intern in ein <em>Array<\/em> umgewandelt. Er kann verwendet werden, um zu \u00fcberschreiben, was derzeit in den Optionen des Plugins eingestellt ist. Es gibt 4 Elemente, die durch \u00dcbergabe eines \u00f6ffnenden oder schlie\u00dfenden HTML-Tags \u00fcberschrieben werden k\u00f6nnen:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>$attr = &#91;<span style=\"font-size: inherit\">\t\t\t<\/span>\n    'before_item'   =&gt; '',\n    'after_item'    =&gt; '',\n    'before_output' =&gt; '',\n    'after_output'  =&gt; '',\n];<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Es gibt auch eine Funktion, die wie <code>get_the_msls()<\/code> funktioniert, aber die Ausgabe direkt ausgibt:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Output the links to the translations in your template\n *\n * You can call this function directly like that\n *\n *     if ( function_exists ( 'the_msls' ) )\n *         the_msls();\n *\n * @uses get_the_msls\n * @param string&#91;] $arr\n *\/\nthe_msls( array $arr = &#91;] ): void;<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Diese Funktion erwartet, dass <code>$attr<\/code> vom Typ <em>Array<\/em> ist.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"msls_blog_collection\">Interaktion mit der Blog Collection<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Der Multisite Language Switcher verbindet Websites miteinander und verwaltet sie mittels einer <em>MslsBlogCollection<\/em>-Instanz:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Gets the MslsBlogCollection instance\n *\n * @return \\lloc\\Msls\\MslsBlogCollection\n *\/\nmsls_blog_collection(): \\lloc\\Msls\\MslsBlogCollection;<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Eine Blog Collection ist im Grunde ein Objekt, das ein <em>Array<\/em> von <em>MslsBlog<\/em>-Objekten enth\u00e4lt. Diese Art von Objekt ist eine erweiterte Form der WordPress-Blog-Objekte, die als \\StdClass bereitgestellt werden.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Sie k\u00f6nnen jedes Blog der Blog Collection abrufen, indem Sie der Funktion <em>msls_blog<\/em> ein Gebietsschema (Locale) \u00fcbergeben:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Gets a blog by locale\n *\n * @param string $locale\n *\n * @return \\lloc\\Msls\\MslsBlog|null\n *\/\nmsls_blog( string $locale ): ?\\lloc\\Msls\\MslsBlog;<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Die Funktion gibt <code>null<\/code> zur\u00fcck, wenn <code>$locale<\/code> in der Blog Collection nicht vorhanden ist.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Helper Funktionen<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Es gibt einige API-Funktionen, mit denen sich bestimmte Informationen sehr einfach abrufen lassen.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"get_msls_flag_url\">Flag Icons abfragen<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Sie k\u00f6nnen die URL eines Flaggensymbols erhalten, indem Sie ein Gebietsschema angeben. Dies sollte f\u00fcr jedes vorhandene Gebietsschema (Locale) funktionieren, ohne in die Blog Collection zu schauen.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Gets the URL of the country flag-icon for a specific locale\n *\n * @param string $locale\n *\n * @return string\n *\/\nfunction get_msls_flag_url( string $locale ): string;<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"get_msls_blog_description\">Blog Beschreibung abfragen<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Die folgende Funktion gibt die Blog-Beschreibung zur\u00fcck, 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\u00fcck und stellt daher einen Parameter <code>$default<\/code> zur Verf\u00fcgung, um etwas Raum f\u00fcr Anpassungen zu geben.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Gets description for a blog with a given locale\n *\n * @param string $locale\n * @param string $default\n *\n * @return string\n *\/\nget_msls_blog_description( string $locale, string $default = '' ): string;<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"get_msls_permalink\">Permalink eines Blogs abfragen<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Die folgende Funktion gibt den Permalink f\u00fcr eine \u00dcbersetzung des aktuellen Inhalts zur\u00fcck. Sie verwendet die Blog-Sammlung wie die obige Funktion und gibt die f\u00fcr <code>$default<\/code> festgelegte Zeichenfolge zur\u00fcck, falls sie fehlschl\u00e4gt.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * Gets permalink for a translation of the current post in a given locale\n *\n * @param string $locale\n * @param string $default\n *\n * @return string\n *\/\nget_msls_permalink( string $locale, string $default = '' ): string;<\/code><\/pre>\n\n\n\n<p class=\"has-text-align-right wp-block-paragraph\"><a href=\"https:\/\/msls.co\/de\/developer-docs\/snippets-beispiele\/\">Snippets &amp; Beispiele \u00bb<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>F\u00fcr 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\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und bietet eine standardisierte M\u00f6glichkeit, mit seinen Funktionen zu interagieren und sie &hellip; <a href=\"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/\" class=\"more-link\"><span class=\"screen-reader-text\">\u201eAPI Funktionen\u201c <\/span>weiterlesen<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"parent":357,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-654","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.7 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>API Funktionen - Multisite Language Switcher<\/title>\n<meta name=\"description\" content=\"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/\" \/>\n<meta property=\"og:locale\" content=\"de_DE\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Funktionen - Multisite Language Switcher\" \/>\n<meta property=\"og:description\" content=\"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/\" \/>\n<meta property=\"og:site_name\" content=\"Multisite Language Switcher\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/realloc\" \/>\n<meta property=\"article:modified_time\" content=\"2025-10-13T15:29:55+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@realloc\" \/>\n<meta name=\"twitter:label1\" content=\"Gesch\u00e4tzte Lesezeit\" \/>\n\t<meta name=\"twitter:data1\" content=\"3\u00a0Minuten\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/api-funktionen\\\/\",\"url\":\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/api-funktionen\\\/\",\"name\":\"API Funktionen - Multisite Language Switcher\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#website\"},\"datePublished\":\"2024-06-19T15:16:05+00:00\",\"dateModified\":\"2025-10-13T15:29:55+00:00\",\"description\":\"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/api-funktionen\\\/#breadcrumb\"},\"inLanguage\":\"de\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/api-funktionen\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/api-funktionen\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/msls.co\\\/de\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Entwickler Dokumentation\",\"item\":\"https:\\\/\\\/msls.co\\\/de\\\/developer-docs\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API Funktionen\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#website\",\"url\":\"https:\\\/\\\/msls.co\\\/de\\\/\",\"name\":\"Multisite Language Switcher\",\"description\":\"WordPress Multilingual \u2013 Simple, powerful and easy to use\",\"publisher\":{\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/msls.co\\\/de\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"de\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#organization\",\"name\":\"Multisite Language Switcher\",\"url\":\"https:\\\/\\\/msls.co\\\/de\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"de\",\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/msls.co\\\/de\\\/wp-content\\\/uploads\\\/sites\\\/12\\\/sites\\\/13\\\/2023\\\/03\\\/cropped-icon.png\",\"contentUrl\":\"https:\\\/\\\/msls.co\\\/de\\\/wp-content\\\/uploads\\\/sites\\\/12\\\/sites\\\/13\\\/2023\\\/03\\\/cropped-icon.png\",\"width\":512,\"height\":512,\"caption\":\"Multisite Language Switcher\"},\"image\":{\"@id\":\"https:\\\/\\\/msls.co\\\/de\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/realloc\",\"https:\\\/\\\/x.com\\\/realloc\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API Funktionen - Multisite Language Switcher","description":"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/","og_locale":"de_DE","og_type":"article","og_title":"API Funktionen - Multisite Language Switcher","og_description":"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.","og_url":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/","og_site_name":"Multisite Language Switcher","article_publisher":"https:\/\/www.facebook.com\/realloc","article_modified_time":"2025-10-13T15:29:55+00:00","twitter_card":"summary_large_image","twitter_site":"@realloc","twitter_misc":{"Gesch\u00e4tzte Lesezeit":"3\u00a0Minuten"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/","url":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/","name":"API Funktionen - Multisite Language Switcher","isPartOf":{"@id":"https:\/\/msls.co\/de\/#website"},"datePublished":"2024-06-19T15:16:05+00:00","dateModified":"2025-10-13T15:29:55+00:00","description":"Die API dient als Br\u00fccke zwischen Ihrer Anwendung und dem Multisite Language Switcher und seinen Funktionen.","breadcrumb":{"@id":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/#breadcrumb"},"inLanguage":"de","potentialAction":[{"@type":"ReadAction","target":["https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/msls.co\/de\/developer-docs\/api-funktionen\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/msls.co\/de\/"},{"@type":"ListItem","position":2,"name":"Entwickler Dokumentation","item":"https:\/\/msls.co\/de\/developer-docs\/"},{"@type":"ListItem","position":3,"name":"API Funktionen"}]},{"@type":"WebSite","@id":"https:\/\/msls.co\/de\/#website","url":"https:\/\/msls.co\/de\/","name":"Multisite Language Switcher","description":"WordPress Multilingual \u2013 Simple, powerful and easy to use","publisher":{"@id":"https:\/\/msls.co\/de\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/msls.co\/de\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"de"},{"@type":"Organization","@id":"https:\/\/msls.co\/de\/#organization","name":"Multisite Language Switcher","url":"https:\/\/msls.co\/de\/","logo":{"@type":"ImageObject","inLanguage":"de","@id":"https:\/\/msls.co\/de\/#\/schema\/logo\/image\/","url":"https:\/\/msls.co\/de\/wp-content\/uploads\/sites\/12\/sites\/13\/2023\/03\/cropped-icon.png","contentUrl":"https:\/\/msls.co\/de\/wp-content\/uploads\/sites\/12\/sites\/13\/2023\/03\/cropped-icon.png","width":512,"height":512,"caption":"Multisite Language Switcher"},"image":{"@id":"https:\/\/msls.co\/de\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/realloc","https:\/\/x.com\/realloc"]}]}},"_links":{"self":[{"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/pages\/654","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/comments?post=654"}],"version-history":[{"count":2,"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/pages\/654\/revisions"}],"predecessor-version":[{"id":729,"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/pages\/654\/revisions\/729"}],"up":[{"embeddable":true,"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/pages\/357"}],"wp:attachment":[{"href":"https:\/\/msls.co\/de\/wp-json\/wp\/v2\/media?parent=654"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}