Documentation

AbstractSyncPlugin extends AbstractLanguagePlugin
in package

AbstractYes

There are plugins like WPML or PolyLang which allows you to create a multilingual WordPress installation. devowl.io plugins needs to be compatible with those plugins so this abstract implementation handles actions like get original ID and get default language.

Table of Contents

Constants

MARKER_SPLIT_TRANSLATION_ENTRY  = 'splitTranslationEntry'
TEMPORARY_TEXT_DOMAIN_PREFIX  = 'multilingual-temporary-text-domain'

Properties

$copyToOtherLanguageMap  : mixed
`copyTermToOtherLanguage` and `copyPostToOtherLanguage` create a duplicate of a term and post. This map holds the mapping of original-ID to translation-ID. This map is filled with the translations like this:
$currentTranslationEntries  : mixed
Current translations hold as an instance.
$findI18nKeyOfTranslationCache  : mixed
$lockCurrentTranslations  : mixed
$splitTranslationEntriesCache  : SplObjectStorage<Translation_Entry, array<string|int, Translation_Entry>>
Cache for split translation entries.
$domain  : string
Use this as text domain for translations. E. g. `post_title` is automatically passed while duplicating a post to another language.
$localesBeforeSwitch  : array<string|int, string>
List of locales before switching locale via `switchToLanguage`.
$moFile  : mixed
$overrideClass  : mixed
$sync  : Sync
The sync instance for this plugin.
$temporaryTextDomain  : TemporaryTextDomain
Temporary text domain, if given.

Methods

__construct()  : mixed
C'tor.
copyPostTaxonomies()  : mixed
Copy already existing taxonomies as it can be inserted with `tax_input` directly.
copyPostToOtherLanguage()  : int|bool
Translate given post to other language.
copyTermToOtherLanguage()  : int|bool
Translate given term to other language.
createTemporaryTextDomain()  : mixed
Create a temporary text domain.
determineImplementation()  : AbstractLanguagePlugin
Determine implementation class.
disableCopyAndSync()  : mixed
Disable sync mechanism of our language plugin as it is handled by `Sync.php`.
duplicatePostMeta()  : mixed
Copy already existing meta as it can be inserted with `meta_input` directly.
filterMetaValue()  : mixed
Apply a WordPress filter so a meta value can be modified for copy process to other languages.
filterWithExistingTranslatedTextDomain()  : mixed
Filter a list of locales and check if translations from a PO/MO file exists.
findI18nKeyOfTranslation()  : mixed
The same as `findI18nKeyOfTranslationRaw`, but with caching enabled as this could be called very often.
findI18nKeyOfTranslationRaw()  : mixed
Find an i18n key for `__()` from a given translated string.
getActiveCountriesFlags()  : mixed
Get the flags of all active languages.
getActiveLanguages()  : array<string|int, string>
Get all active languages.
getCountryFlag()  : string|false
Get a `src` compatible link to the country flag.
getCurrentLanguage()  : string
Get current language.
getCurrentLanguageFallback()  : mixed
Get current language or fallback to default language when the multilingual is in a state like "Show all languages" (option known in the admin toolbar).
getCurrentPostId()  : int
Get current id of passed post id and fallback to passed id, when no translation found.
getCurrentTermId()  : int
Get current id of passed term id and fallback to `0` when not translation found.
getDefaultLanguage()  : string
Get default language.
getLanguageSwitcher()  : array<string|int, array<string|int, mixed>>
Get a language switcher for the current page.
getLocalesBeforeSwitch()  : mixed
List of locales before switching locale via `switchToLanguage`.
getOriginalPostId()  : int
Get original id of passed post id.
getOriginalTermId()  : int
Get original id of passed term id.
getOverrideClassInstance()  : mixed
Get an instance of the `overrideClass`.
getPermalink()  : string
Get the URL of a given URL for another locale.
getPostTranslationIds()  : array<string|int, int>
Get all translations of a given post type.
getSkipHTMLForTag()  : string
Get the HTML attribute so the "dynamic" replacement gets disabled on frontend side. This can be useful for texts which are directly translated in PHP already and gets translated via JavaScript again.
getSync()  : mixed
Get `Sync` instance for this plugin. Can be `null` if not given.
getTaxonomyTranslationIds()  : array<string|int, int>
Get all translations of a given taxonomy.
getTemporaryTextDomainName()  : mixed
Get the current temporary text domain name which can be used for `__` when e.g. inside `switchToLanguage`.
getTranslatedName()  : string
Get translated name for a given locale.
getWordPressCompatibleLanguageCode()  : string
Get the WordPress compatible language code of a given locale.
isActive()  : mixed
Is a multilingual plugin active?
isCurrentlyInEditorPreview()  : bool
Check if the translate plugin is currently in edit mode (preview).
iterateAllLanguagesContext()  : mixed
Iterate all language contexts.
iterateOtherLanguagesContext()  : mixed
Iterate all other languages than current one and get their context.
lockCurrentTranslations()  : mixed
Do not allow to take another snapshot of current translations.
maybePersistTranslation()  : mixed
Maybe persist a translation in the database of available translations.
postCopiedToAllOtherLanguages()  : mixed
This method is called due to `Sync::save_post`. It allows you to get a list of all translations of a post in an associate array.
rest_prepare_post()  : mixed
Add a `multilingual` section to a given post type.
rest_prepare_taxonomy()  : mixed
Add a `multilingual` section to a given taxonomy.
setPostLanguage()  : mixed
This method is called due to `Sync::save_post`. It allows you to assign a post to a given language.
setSync()  : mixed
Set `Sync` instance for this plugin. Can be `null` if not given.
setTermLanguage()  : mixed
This method is called due to `Sync::created_term`. It allows you to assign a term to a given language.
snapshotCurrentTranslations()  : mixed
Snapshot the current translations.
splitTranslationEntries()  : mixed
Split a translation entry key into multiple parts. This is useful when using e.g. TranslatePress and we need to find translations from MO file which is divided into multiple "parts" like `<strong>Text</strong>: Another text`.
switch()  : mixed
Switch to a given language code. Please do not use this function directly, use `switchToLanguage` instead!
switchToLanguage()  : mixed
Open given language and get their context. Context = switch to the language.
teardownTemporaryTextDomain()  : mixed
Teardown the known temporary text domain.
termCopiedToAllOtherLanguages()  : mixed
This method is called due to `Sync::created_term`. It allows you to get a list of all translations of a term in an associate array.
translatableStrings()  : array<string|int, array<string|int, string>>
Extract translatable strings from a given content. The returned array is a map of the original strings to the translatable strings.
translateArray()  : array<string|int, mixed>
Translate a complete array to a given locale (recursively). This is mostly implemented by output buffer plugins like TranslatePress or Weglot.
translateInput()  : mixed
Translate a given input from known translations (.po, .pot).
translateStrings()  : mixed
Translate strings to a given locale. Do not use this function directly, use `translateArray` instead!
unsetCurrentTranslations()  : mixed
Unset current translations.
duplicateMeta()  : mixed
Listen to meta (term, post, ...) addition and copy.
duplicatePost()  : mixed
A simple `get_post` => `wp_insert_post` wrapper.
duplicateTerm()  : mixed
A simple `get_term` => `wp_insert_term` wrapper.
duplicateTermMeta()  : mixed
Listen to term meta addition and copy.
translateStringFromMo()  : array<string|int, mixed>
Translate string from `.mo` file. Please consider to create a temporary text domain before!

Constants

MARKER_SPLIT_TRANSLATION_ENTRY

public mixed MARKER_SPLIT_TRANSLATION_ENTRY = 'splitTranslationEntry'

TEMPORARY_TEXT_DOMAIN_PREFIX

public mixed TEMPORARY_TEXT_DOMAIN_PREFIX = 'multilingual-temporary-text-domain'

Properties

$copyToOtherLanguageMap

`copyTermToOtherLanguage` and `copyPostToOtherLanguage` create a duplicate of a term and post. This map holds the mapping of original-ID to translation-ID. This map is filled with the translations like this:

protected mixed $copyToOtherLanguageMap = ['post' => [], 'term' => []]
{
  "post": {
    "de": {
         800: 801
    }
  }
}

$currentTranslationEntries

Current translations hold as an instance.

protected mixed $currentTranslationEntries = null

$splitTranslationEntriesCache

Cache for split translation entries.

protected SplObjectStorage<Translation_Entry, array<string|int, Translation_Entry>> $splitTranslationEntriesCache = []

$domain

Use this as text domain for translations. E. g. `post_title` is automatically passed while duplicating a post to another language.

private string $domain

$localesBeforeSwitch

List of locales before switching locale via `switchToLanguage`.

private array<string|int, string> $localesBeforeSwitch = []

Methods

__construct()

C'tor.

public __construct(string $domain[, string $moFile = null ][, mixed $overrideClass = null ]) : mixed
Parameters
$domain : string

Original text domain where post_title and so on are translated

$moFile : string = null

Needed for TemporaryTextDomain. E. g. /var/www/html/wp-content/plugins/real-cookie-banner/languages/real-cookie-banner-%s.mo

$overrideClass : mixed = null

A class with a getPotLanguages method

Tags
codeCoverageIgnore

copyPostTaxonomies()

Copy already existing taxonomies as it can be inserted with `tax_input` directly.

public copyPostTaxonomies(int $from, int $to, array<string|int, string> $taxonomies, string $locale) : mixed

Additionally listen to term additions and copy.

Parameters
$from : int
$to : int
$taxonomies : array<string|int, string>

Taxonomy keys to copy

$locale : string

The destination locale

copyPostToOtherLanguage()

Translate given post to other language.

public copyPostToOtherLanguage(string $locale, string $currentLanguage, string $post_id, array<string|int, string> $meta, array<string|int, string> $taxonomies) : int|bool
Parameters
$locale : string
$currentLanguage : string
$post_id : string
$meta : array<string|int, string>

The meta keys to copy

$taxonomies : array<string|int, string>

The taxonomies to copy

Return values
int|bool

The new created post id

copyTermToOtherLanguage()

Translate given term to other language.

public copyTermToOtherLanguage(string $locale, string $currentLanguage, int $term_id, string $taxonomy, array<string|int, string> $meta) : int|bool
Parameters
$locale : string
$currentLanguage : string
$term_id : int
$taxonomy : string
$meta : array<string|int, string>

The meta keys to copy

Return values
int|bool

The new created term id

createTemporaryTextDomain()

Create a temporary text domain.

public createTemporaryTextDomain(string $locale[, bool $force = false ]) : mixed
Parameters
$locale : string
$force : bool = false

determineImplementation()

Determine implementation class.

public static determineImplementation([string $domain = '' ][, string $moFile = null ][, mixed $overrideClass = null ]) : AbstractLanguagePlugin
Parameters
$domain : string = ''
$moFile : string = null

Needed for TemporaryTextDomain. E. g. /var/www/html/wp-content/plugins/real-cookie-banner/languages/real-cookie-banner-%s.mo

$overrideClass : mixed = null

A class with a override method (arguments: locale)

Return values
AbstractLanguagePlugin

disableCopyAndSync()

Disable sync mechanism of our language plugin as it is handled by `Sync.php`.

public abstract disableCopyAndSync(Sync $sync) : mixed
Parameters
$sync : Sync

duplicatePostMeta()

Copy already existing meta as it can be inserted with `meta_input` directly.

public duplicatePostMeta(int $from, int $to, array<string|int, string> $meta) : mixed

Additionally listen to term meta addition and copy.

Parameters
$from : int
$to : int
$meta : array<string|int, string>

Meta keys to copy

filterMetaValue()

Apply a WordPress filter so a meta value can be modified for copy process to other languages.

public filterMetaValue(string $type, int $from, int $to, string $meta_key, mixed $meta_value, string $locale) : mixed
Parameters
$type : string

E. g. 'post'

$from : int

Object id of source language item

$to : int

Object id of destination language item

$meta_key : string
$meta_value : mixed
$locale : string

Destination locale

filterWithExistingTranslatedTextDomain()

Filter a list of locales and check if translations from a PO/MO file exists.

public filterWithExistingTranslatedTextDomain(array<string|int, string> $locales[, array<string|int, string> $skip = [] ]) : mixed
Parameters
$locales : array<string|int, string>
$skip : array<string|int, string> = []

Allows to skip locales and they will never be in the result, e.g. minimal translations; the codes need to be compatible with the WordPress locale format.

findI18nKeyOfTranslation()

The same as `findI18nKeyOfTranslationRaw`, but with caching enabled as this could be called very often.

public findI18nKeyOfTranslation(string $input, bool &$found, array<string|int, string> &$contexts) : mixed
Parameters
$input : string
$found : bool
$contexts : array<string|int, string>

findI18nKeyOfTranslationRaw()

Find an i18n key for `__()` from a given translated string.

public findI18nKeyOfTranslationRaw(string $input, bool &$found, array<string|int, string> &$contexts) : mixed
Parameters
$input : string
$found : bool

Sets to true when a translation got found

$contexts : array<string|int, string>

getActiveCountriesFlags()

Get the flags of all active languages.

public getActiveCountriesFlags() : mixed

getActiveLanguages()

Get all active languages.

public abstract getActiveLanguages() : array<string|int, string>
Return values
array<string|int, string>

getCountryFlag()

Get a `src` compatible link to the country flag.

public abstract getCountryFlag(string $locale) : string|false
Parameters
$locale : string
Return values
string|false

getCurrentLanguage()

Get current language.

public abstract getCurrentLanguage() : string
Return values
string

getCurrentLanguageFallback()

Get current language or fallback to default language when the multilingual is in a state like "Show all languages" (option known in the admin toolbar).

public getCurrentLanguageFallback() : mixed

getCurrentPostId()

Get current id of passed post id and fallback to passed id, when no translation found.

public abstract getCurrentPostId(int $id, string $post_type[, string $locale = null ]) : int
Parameters
$id : int
$post_type : string
$locale : string = null

Get item of this language

Return values
int

getCurrentTermId()

Get current id of passed term id and fallback to `0` when not translation found.

public abstract getCurrentTermId(int $id, string $taxonomy[, string $locale = null ]) : int
Parameters
$id : int
$taxonomy : string
$locale : string = null

Get item of this language

Return values
int

getDefaultLanguage()

Get default language.

public abstract getDefaultLanguage() : string
Return values
string

getLanguageSwitcher()

Get a language switcher for the current page.

public abstract getLanguageSwitcher() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>>

getLocalesBeforeSwitch()

List of locales before switching locale via `switchToLanguage`.

public getLocalesBeforeSwitch() : mixed

getOriginalPostId()

Get original id of passed post id.

public abstract getOriginalPostId(int $id, string $post_type) : int
Parameters
$id : int
$post_type : string
Return values
int

getOriginalTermId()

Get original id of passed term id.

public abstract getOriginalTermId(int $id, string $taxonomy) : int
Parameters
$id : int
$taxonomy : string
Return values
int

getOverrideClassInstance()

Get an instance of the `overrideClass`.

public getOverrideClassInstance() : mixed

Get the URL of a given URL for another locale.

public abstract getPermalink(string $url, string $locale) : string
Parameters
$url : string
$locale : string
Return values
string

getPostTranslationIds()

Get all translations of a given post type.

public abstract getPostTranslationIds(int $id, string $post_type) : array<string|int, int>
Parameters
$id : int
$post_type : string
Return values
array<string|int, int>

getSkipHTMLForTag()

Get the HTML attribute so the "dynamic" replacement gets disabled on frontend side. This can be useful for texts which are directly translated in PHP already and gets translated via JavaScript again.

public getSkipHTMLForTag([mixed $force = false ]) : string
Parameters
$force : mixed = false

Pass true to get the attribute and do not respect isCurrentlyInEditorPreview

Return values
string

getSync()

Get `Sync` instance for this plugin. Can be `null` if not given.

public getSync() : mixed

getTaxonomyTranslationIds()

Get all translations of a given taxonomy.

public abstract getTaxonomyTranslationIds(int $id, string $taxonomy) : array<string|int, int>
Parameters
$id : int
$taxonomy : string
Return values
array<string|int, int>

getTemporaryTextDomainName()

Get the current temporary text domain name which can be used for `__` when e.g. inside `switchToLanguage`.

public getTemporaryTextDomainName() : mixed

getTranslatedName()

Get translated name for a given locale.

public abstract getTranslatedName(string $locale) : string
Parameters
$locale : string
Return values
string

getWordPressCompatibleLanguageCode()

Get the WordPress compatible language code of a given locale.

public abstract getWordPressCompatibleLanguageCode(string $locale) : string
Parameters
$locale : string
Return values
string

isCurrentlyInEditorPreview()

Check if the translate plugin is currently in edit mode (preview).

public isCurrentlyInEditorPreview() : bool
Return values
bool

iterateAllLanguagesContext()

Iterate all language contexts.

public iterateAllLanguagesContext(callable $callback[, array<string|int, string> $skip = [] ]) : mixed
Parameters
$callback : callable

Arguments: $locale, $currentLanguage

$skip : array<string|int, string> = []

Skip locales

iterateOtherLanguagesContext()

Iterate all other languages than current one and get their context.

public iterateOtherLanguagesContext(callable $callback) : mixed

Context = switch to the language.

Attention: If you are using switchToLanguage in a REST API call, please consider to pass the _wp_http_referer parameter. E.g. TranslatePress checks if the referer is an admin page and behaves differently.

Parameters
$callback : callable

Arguments: $locale, $currentLanguage

lockCurrentTranslations()

Do not allow to take another snapshot of current translations.

public lockCurrentTranslations([bool $state = false ]) : mixed
Parameters
$state : bool = false

maybePersistTranslation()

Maybe persist a translation in the database of available translations.

public maybePersistTranslation(mixed $sourceContent, mixed $content, mixed $sourceLocale, mixed $targetLocale[, mixed $force = false ]) : mixed
Parameters
$sourceContent : mixed
$content : mixed

Pass null to delete the translation

$sourceLocale : mixed
$targetLocale : mixed
$force : mixed = false

Pass true to force persist the translation

postCopiedToAllOtherLanguages()

This method is called due to `Sync::save_post`. It allows you to get a list of all translations of a post in an associate array.

public postCopiedToAllOtherLanguages(array<string|int, int> $translations) : mixed
Parameters
$translations : array<string|int, int>

setPostLanguage()

This method is called due to `Sync::save_post`. It allows you to assign a post to a given language.

public setPostLanguage(int $postId, string $locale) : mixed
Parameters
$postId : int
$locale : string

setSync()

Set `Sync` instance for this plugin. Can be `null` if not given.

public setSync(Sync $sync) : mixed
Parameters
$sync : Sync

setTermLanguage()

This method is called due to `Sync::created_term`. It allows you to assign a term to a given language.

public setTermLanguage(int $termId, string $locale) : mixed
Parameters
$termId : int
$locale : string

snapshotCurrentTranslations()

Snapshot the current translations.

public snapshotCurrentTranslations([bool $force = false ]) : mixed
Parameters
$force : bool = false

splitTranslationEntries()

Split a translation entry key into multiple parts. This is useful when using e.g. TranslatePress and we need to find translations from MO file which is divided into multiple "parts" like `<strong>Text</strong>: Another text`.

public splitTranslationEntries(array<string|int, Translation_Entry&$entriesToSplit) : mixed
Parameters
$entriesToSplit : array<string|int, Translation_Entry>
Tags
see
https://github.com/WordPress/WordPress/blob/8df15c4374b5cea6627e3f149058904bfa793dcf/wp-includes/pomo/entry.php

switch()

Switch to a given language code. Please do not use this function directly, use `switchToLanguage` instead!

public abstract switch(string $locale) : mixed
Parameters
$locale : string

switchToLanguage()

Open given language and get their context. Context = switch to the language.

public switchToLanguage(string $locale, callable $callback) : mixed

Attention: If you are using switchToLanguage in a REST API call, please consider to pass the _wp_http_referer parameter. E.g. TranslatePress checks if the referer is an admin page and behaves differently.

Parameters
$locale : string
$callback : callable

Arguments: $locale, $currentLanguage

teardownTemporaryTextDomain()

Teardown the known temporary text domain.

public teardownTemporaryTextDomain() : mixed

termCopiedToAllOtherLanguages()

This method is called due to `Sync::created_term`. It allows you to get a list of all translations of a term in an associate array.

public termCopiedToAllOtherLanguages(array<string|int, int> $translations) : mixed
Parameters
$translations : array<string|int, int>

translatableStrings()

Extract translatable strings from a given content. The returned array is a map of the original strings to the translatable strings.

public translatableStrings(mixed $content) : array<string|int, array<string|int, string>>
Parameters
$content : mixed
Return values
array<string|int, array<string|int, string>>

translateArray()

Translate a complete array to a given locale (recursively). This is mostly implemented by output buffer plugins like TranslatePress or Weglot.

public translateArray(array<string|int, mixed> $content[, array<string|int, string> $skipKeys = [] ][, string $locale = null ][, array<string|int, string> $context = null ]) : array<string|int, mixed>
Parameters
$content : array<string|int, mixed>
$skipKeys : array<string|int, string> = []
$locale : string = null
$context : array<string|int, string> = null
Return values
array<string|int, mixed>

translateInput()

Translate a given input from known translations (.po, .pot).

public translateInput(string $input[, array<string|int, string> $contexts = null ]) : mixed
Parameters
$input : string
$contexts : array<string|int, string> = null

translateStrings()

Translate strings to a given locale. Do not use this function directly, use `translateArray` instead!

public translateStrings(mixed &$content, mixed $locale[, mixed $context = null ]) : mixed
Parameters
$content : mixed

This parameter needs to be passed as reference map, see also translateArray. The implementation needs to update the references correctly

$locale : mixed
$context : mixed = null

unsetCurrentTranslations()

Unset current translations.

public unsetCurrentTranslations() : mixed

duplicateMeta()

Listen to meta (term, post, ...) addition and copy.

protected duplicateMeta(string $type, int $from, int $to, array<string|int, string> $meta) : mixed
Parameters
$type : string

E. g. 'post'

$from : int
$to : int
$meta : array<string|int, string>

Meta keys to copy

duplicatePost()

A simple `get_post` => `wp_insert_post` wrapper.

protected duplicatePost(WP_Post $post) : mixed
Parameters
$post : WP_Post

duplicateTerm()

A simple `get_term` => `wp_insert_term` wrapper.

protected duplicateTerm(WP_Term $term, string $taxonomy) : mixed
Parameters
$term : WP_Term
$taxonomy : string

duplicateTermMeta()

Listen to term meta addition and copy.

protected duplicateTermMeta(int $from, int $to, array<string|int, string> $meta) : mixed
Parameters
$from : int
$to : int
$meta : array<string|int, string>

Meta keys to copy

translateStringFromMo()

Translate string from `.mo` file. Please consider to create a temporary text domain before!

protected translateStringFromMo(string $content, string $targetLocale[, array<string|int, string> $context = null ]) : array<string|int, mixed>
Parameters
$content : string
$targetLocale : string
$context : array<string|int, string> = null
Return values
array<string|int, mixed>

[$found: boolean, $content: string]


        
On this page

Search results