Documentation

Guides, references, and API documentation for PerfLocale

Getting Started

The basics - translate content, pick a URL layout, drop in a language switcher.

Getting Started GuideStep-by-step from activation to a fully translated post in 15 minutes. Content TranslationTranslate posts, pages, and custom post types. Full Site EditingTranslate block theme templates and template parts. String TranslationTranslate gettext strings from themes and plugins. URL & RoutingPick subdirectory, subdomain, domain, or query-parameter structure. Language SwitcherBlock, shortcode, widget, and template tags. Translations AdminThe admin page that shows what's done and what isn't. ShortcodesFull shortcode reference.

Production Tuning

Get a production-ready setup - caches, CDN, and database sizing.

Production Tuning GuideThe complete walkthrough, with example query counts. Background JobsHow long-running operations move off the request path. Settings, recovery, CLI, REST. Reliability & Circuit BreakersOperator's guide to breakers, locks, Site Health checks, and data retention. CDN Cache-Tag HeadersPer-language CDN purge tags. Edge IntegrationCloudflare Workers, Vercel & Netlify Edge routing. Exchange Rate SyncScheduled multi-currency rate refresh — bring your own rate source.

Developer API

Hooks, REST endpoints, WP-CLI, and the addon contract.

Developer API OverviewBuild on top of PerfLocale. Addon SystemSchema & uninstall contracts for custom integrations. Hooks Reference200+ actions and filters. REST APIFull endpoint documentation. WP-CLI CommandsCommand-line tools for automation. Helper APIFluent PHP helper functions for templates. API Keys (env / constant / DB)Resolve secrets from env vars first, then wp-config.php constants, then admin settings.

Integrations & Features

WooCommerce, machine translation, SEO, and more.

WooCommerce GuideProduct translation and multi-currency. Machine TranslationDeepL, Google, Microsoft, LibreTranslate. SEOHreflang, sitemap, and SEO plugin integration. SEO Schema EnrichmentJSON-LD inLanguage + translation cross-links. GeoIP RedirectAuto-redirect visitors by country or browser language. Conditional ContentShow content by language - block, shortcode, PHP. Language FallbacksWhat to show when a translation is missing. Bundled AddonsEvery theme, page builder, and SEO plugin we support.

Operations & Migration

Permissions, data export/import, migration from other plugins, and privacy.

Permissions & RolesUser capabilities and the translator role. Export & ImportXLIFF and JSON for external translators. MigrationMove from WPML, Polylang, or TranslatePress. PrivacyWhat data the plugin stores, GDPR compliance. MultisiteNetwork installs, per-site languages, and URL modes. TroubleshootingSite Health warnings and what to do about them.