Ability category.
public
mixed
JPKCOM_SIMPLELANG_ABILITY_CATEGORY
= 'jpkcom-content'
Categories are global and registration is FIRST-WINS, so this goes through wp_has_ability_category() rather than assuming.
Top-level input keys each ability declares.
public
mixed
JPKCOM_SIMPLELANG_ABILITY_INPUT_KEYS
= ['jpkcom-simple-lang/list-languages' => [], 'jpkcom-simple-lang/check-translation-sets' => ['page', 'per_page']]
Cross-checked against the registered schemas by tests/test-abilities.php. additionalProperties is deliberately not declared on the schema that carries properties: validate_input() runs before the execute callback and would preempt the guard below, replacing a message naming the accepted keys with core's "not a valid property of the object".
Default page size for the set check.
public
mixed
JPKCOM_SIMPLELANG_ABILITY_PER_PAGE_DEFAULT
= 20
Largest page size honoured.
public
mixed
JPKCOM_SIMPLELANG_ABILITY_PER_PAGE_MAX
= 100
Largest number of linked posts examined in one call.
public
mixed
JPKCOM_SIMPLELANG_ABILITY_SCAN_LIMIT
= 2000
Building the sets means reading every post that carries a translation link, which is unbounded on a large site. The cap is reported back rather than applied silently: an answer that stopped early while looking complete is the failure this field exists to prevent.
public
mixed
JPKCOM_SIMPLELANG_BASENAME
= \plugin_basename(__FILE__)
public
mixed
JPKCOM_SIMPLELANG_PLUGIN_PATH
= \plugin_dir_path(__FILE__)
public
mixed
JPKCOM_SIMPLELANG_PLUGIN_URL
= \plugin_dir_url(__FILE__)
public
mixed
JPKCOM_SIMPLELANG_VERSION
= '1.3.0'
Decide whether the abilities should be registered at all.
jpkcom_simplelang_abilities_enabled() : bool
True when registration should proceed.
Write a debug line, and only with WP_DEBUG.
jpkcom_simplelang_ability_log(string $message) : void
Message.
Build a WP_Error carrying an HTTP status.
jpkcom_simplelang_ability_error(string $code, string $message[, int $status = 400 ]) : WP_Error
Without data['status'] rest_ensure_response() defaults to 500, and a 5xx tells an agent "transient fault, retry unchanged" - the opposite of what a caller mistake needs to hear.
Error code.
Message.
HTTP status.
Error.
Turn a Throwable out of a callback into a WP_Error.
jpkcom_simplelang_ability_boundary(callable $body, string $ability) : array<string, mixed>|WP_Error
Callback.
Ability name.
Result or error.
Wrap an empty map so it encodes as {} rather than [].
jpkcom_simplelang_ability_json_object(array<string, mixed> $map) : array<string, mixed>|stdClass
Map.
Map, or an empty object.
Check the capability required to run an ability.
jpkcom_simplelang_ability_capability(string $ability) : bool
edit_posts, not read. This reports an editorial and SEO condition of
the site - which pages are annotated for which language, and where that
annotation comes out incomplete - and it names unpublished and dangling
posts while doing so. That is not visitor-facing content.
Ability name.
True when the current user may run it.
Build the meta array for an ability.
jpkcom_simplelang_ability_meta(string $ability) : array<string, mixed>
All three annotations explicit: they default to null and the REST run controller derives the HTTP verb from them, so without readonly the run route would be POST-only.
Ability name.
Meta array.
Bring the value core hands the callback into array form.
jpkcom_simplelang_ability_normalise_input(mixed $input) : array<string, mixed>|null
normalize_input() substitutes the schema's top-level default when the input is exactly null, and that default is a stdClass - so the callback receives an object and must read it.
Raw input.
Array form, or null when unusable.
Refuse a top-level input key the ability does not declare.
jpkcom_simplelang_ability_validate_input_keys(array<string, mixed> $input, array<string|int, string> $allowed) : true|WP_Error
On EVERY ability, not a subset: a caller that learned the refusal on one assumes it everywhere, and the ability that silently accepts is the one it will trust.
Raw input.
Declared keys.
True when every key is declared.
The post types language selection is enabled for.
jpkcom_simplelang_ability_enabled_post_types() : array<string|int, string>
Reads the same option and the same default the rest of the plugin reads, rather than restating either.
Post type names.
Describe a locale the way the front end resolves it.
jpkcom_simplelang_ability_describe_locale(string $locale, array<string|int, string> $installed) : array<string, mixed>
installed matters more than it looks: a locale whose language pack was
removed stays in the post meta, and switch_to_locale() then returns false,
so the front end deliberately does NOT switch. The page keeps the site
language while its meta still claims another one.
Locale, or '' for "no language of its own".
Installed locales.
Description.
Report which languages this site actually uses.
jpkcom_simplelang_ability_list_languages_inner([mixed $input = null ]) : array<string, mixed>|WP_Error
Ability input.
Result.
Collect the translation sets on this site.
jpkcom_simplelang_ability_build_sets(array<string|int, string> $types) : array{sets: array, scanned: int, truncated: bool}
A set is a post plus everything it links to. Because the links are bidirectional, the same set is reachable from each of its members, so sets are deduplicated by their sorted member list.
Enabled post types.
Sets.
Report what the hreflang output for one set will and will not contain.
jpkcom_simplelang_ability_inspect_set(array<string|int, int> $members, string $default_tag, array<string|int, string> $installed) : array<string, mixed>
Every finding below is derived from what the emitter does, not from an opinion about what it should do:
Member post IDs.
Site default BCP 47 tag.
Installed locales.
Report for this set.
Report the translation sets whose hreflang output comes out incomplete.
jpkcom_simplelang_ability_check_sets_inner([mixed $input = null ]) : array<string, mixed>|WP_Error
Ability input.
Result.
Permission callback for list-languages.
jpkcom_simplelang_ability_permission_list_languages([mixed $input = null ]) : bool
Validated input, unused.
True when the current user may run it.
Permission callback for check-translation-sets.
jpkcom_simplelang_ability_permission_check_sets([mixed $input = null ]) : bool
Validated input, unused.
True when the current user may run it.
Execute callback for jpkcom-simple-lang/list-languages.
jpkcom_simplelang_ability_list_languages([mixed $input = null ]) : array<string, mixed>|WP_Error
Ability input.
Result.
Execute callback for jpkcom-simple-lang/check-translation-sets.
jpkcom_simplelang_ability_check_sets([mixed $input = null ]) : array<string, mixed>|WP_Error
Ability input.
Result.
Build the registration arguments for both abilities.
jpkcom_simplelang_get_ability_definitions() : array<string, array<string, mixed>>
Reads no WordPress state and touches no registry, which is what lets the CI harness assert the shape of these arrays without a WordPress installation.
Ability name => registration args.
Register the shared category, unless a sibling plugin already did.
jpkcom_simplelang_register_ability_category() : void
Register both abilities.
jpkcom_simplelang_register_abilities() : void
wp_register_ability() returns null on EVERY failure path and reports only through _doing_it_wrong(), which is silent in production - and so is the debug log without WP_DEBUG.
Sanitize post types array
jpkcom_simplelang_sanitize_post_types(array<int, string>|null $value) : array<int, string>
Ensures only valid post types are saved in the settings.
The post types array to sanitize.
Sanitized array of valid post types.
Render enabled post types field
jpkcom_simplelang_enabled_post_types_field() : void
Displays checkboxes for all public post types.
Render settings page
jpkcom_simplelang_settings_page() : void
Displays the admin settings page for Simple Lang plugin.
Convert locale to language code
jpkcom_simplelang_get_language_code(string $locale) : string
Converts a locale string (e.g., de_DE) to a language code (e.g., de).
Kept for backwards compatibility. For markup that needs a language tag use jpkcom_simplelang_get_bcp47() instead — a bare subtag cannot express de-DE versus de-AT, and hreflang needs that distinction.
The locale string.
The language code.
Convert a WordPress locale to a BCP 47 language tag
jpkcom_simplelang_get_bcp47(string $locale) : string
de_DE becomes de-DE, en_US becomes en-US, ca stays ca. WordPress
variant suffixes carry no BCP 47 meaning and are dropped, so de_DE_formal
and de_CH_informal become de-DE and de-CH, and pt_PT_ao90 becomes
pt-PT — a formal and an informal German page are the same language and
region as far as a search engine is concerned.
The WordPress locale (e.g. 'de_DE', 'de_DE_formal').
The BCP 47 tag (e.g. 'de-DE').
Get current frontend language
jpkcom_simplelang_get_current_language() : string|null
Returns the currently active language for the frontend.
The current language locale or null if using site default.
Get site default locale
jpkcom_simplelang_get_site_default_locale() : string
Returns the site's default locale, ignoring any temporary locale switches. This is the locale set in Settings > General.
The site default locale (e.g., 'de_DE', 'en_US').
Get language name from locale
jpkcom_simplelang_get_language_name(string $locale) : string
Converts a locale code to a human-readable language name.
The locale code (e.g., 'de_DE', 'fr_FR').
The language name in native language.
Group posts by language
jpkcom_simplelang_group_posts_by_language(array<string, mixed> $query_args) : array<string, array<int, WP_Post>>
Queries posts and groups them by their assigned language for display in the translation links meta box.
WP_Query arguments.
Posts grouped by locale.
Validate translation links
jpkcom_simplelang_validate_translations(int $post_id, array<string|int, int> $translation_ids) : array<string|int, int>
Ensures that translation links are valid and prevents duplicate languages.
The current post ID.
Array of translation post IDs.
Validated array of translation post IDs.
Get translation posts efficiently
jpkcom_simplelang_get_translation_posts(array<string|int, int> $post_ids) : array<string|int, WP_Post>
Fetches multiple posts in a single query to avoid N+1 query problems.
Array of post IDs to fetch.
Array of post objects.
Sync translation links bidirectionally
jpkcom_simplelang_sync_translations(int $post_id, array<string|int, int> $new_translations) : void
Updates translation links for the current post and ensures all posts in the translation set are linked to each other. Creates a complete translation set where every post links to all others in the set.
The post ID to sync.
Array of translation post IDs.
Render translation links meta box
jpkcom_simplelang_render_translations_meta_box(WP_Post $post) : void
Displays a multi-select dropdown with posts grouped by language.
Current post object.
Generate and output hreflang tags
jpkcom_simplelang_output_hreflang_tags(int $post_id, array<string|int, int> $translation_ids) : void
Creates hreflang link tags for all translations including the current post.
The current post ID.
Array of translation post IDs.
Render language selection meta box
jpkcom_simplelang_render_meta_box(WP_Post $post) : void
Displays a dropdown with all available WordPress languages.
Current post object.
Check whether a locale may be stored as a post language
jpkcom_simplelang_is_valid_locale(string $locale) : bool
Validated against the locales WordPress actually has installed, plus en_US,
which needs no language pack. That is the same list the meta box builds its
options from, so anything offered can also be saved.
Up to 1.2.8 this was a regex, /^[a-z]{2,3}(_[A-Z]{2})?$/, which silently
rejected every WordPress variant locale: de_DE_formal, nl_NL_formal,
de_CH_informal, pt_PT_ao90 and art_xemoji. The meta box offered them,
save_post dropped them, and nothing said so — this plugin even ships
de_DE_formal translations of its own. A whitelist is both stricter (no
invented locales) and complete (every real one).
The locale to check.
True when the locale may be stored.
Get post language
jpkcom_simplelang_get_post_language([int|null $post_id = null ]) : string|null
Retrieves the language set for a specific post.
Optional. Post ID. Defaults to current post.
The language locale or null if not set.
Get language options for Oxygen Builder
jpkcom_simplelang_get_oxygen_language_options() : array<string, string>
Returns an array of available languages formatted for Oxygen Builder conditions.
Array of language codes and names.
Oxygen condition callback: Post language is specific value
jpkcom_simplelang_oxygen_post_language_is(string $value, string $operator) : bool
Checks if the post has a specific language set.
The language code to check.
The comparison operator (== or !=).
True if the condition matches.
Oxygen condition callback: Post has custom language
jpkcom_simplelang_oxygen_has_custom_language(string $value, string $operator) : bool
Checks if the post has any custom language set (not using site default).
The value to check ('true' or 'false').
The comparison operator (always ==).
True if the condition matches.
Oxygen condition callback: Post uses default language
jpkcom_simplelang_oxygen_uses_default_language(string $value, string $operator) : bool
Checks if the post is using the site default language (no custom language set).
The value to check ('true' or 'false').
The comparison operator (always ==).
True if the condition matches.
Load plugin text domain for translations
jpkcom_simplelang_textdomain() : void
Loads translation files from the /languages directory.
Locate file with override support
jpkcom_simplelang_locate_file(string $filename) : string|null
Searches for a file in multiple locations with priority:
The filename to locate (without path).
Full path to the file if found, null otherwise.