2022-08-11 14:39:12 +02:00
|
|
|
<?php
|
|
|
|
/**
|
2023-02-09 17:35:22 +01:00
|
|
|
* Locale API: WP_Textdomain_Registry class.
|
|
|
|
*
|
|
|
|
* This file uses rtrim() instead of untrailingslashit() and trailingslashit()
|
|
|
|
* to avoid formatting.php dependency.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage i18n
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Core class used for registering text domains.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP.
The logic used for this commit is as follows:
* If a class already has the attribute: no action needed.
* If a class does not `extend`: add the attribute.
* If a class does `extend`:
- If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties).
- If it extends a PHP native class: add the attribute.
- If it extends a class from one of WP's external dependencies: add the attribute.
* In all other cases: no action — the attribute should not be needed as child classes inherit from the parent.
Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details.
This commit only affects classes in the `src` directory of WordPress core.
* Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033.
* While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922].
Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath.
See #56513, #56034.
Built from https://develop.svn.wordpress.org/trunk@54133
git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-12 17:47:14 +02:00
|
|
|
#[AllowDynamicProperties]
|
2022-08-11 14:39:12 +02:00
|
|
|
class WP_Textdomain_Registry {
|
|
|
|
/**
|
|
|
|
* List of domains and all their language directory paths for each locale.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $all = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of domains and their language directory path for the current (most recent) locale.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $current = array();
|
|
|
|
|
2022-10-24 12:02:16 +02:00
|
|
|
/**
|
|
|
|
* List of domains and their custom language directory paths.
|
|
|
|
*
|
|
|
|
* @see load_plugin_textdomain()
|
|
|
|
* @see load_theme_textdomain()
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $custom_paths = array();
|
|
|
|
|
2022-08-11 14:39:12 +02:00
|
|
|
/**
|
|
|
|
* Holds a cached list of available .mo files to improve performance.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
2022-12-20 16:12:11 +01:00
|
|
|
protected $cached_mo_files = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Holds a cached list of domains with translations to improve performance.
|
|
|
|
*
|
|
|
|
* @since 6.1.2
|
|
|
|
*
|
|
|
|
* @var string[]
|
|
|
|
*/
|
|
|
|
protected $domains_with_translations = array();
|
2022-08-11 14:39:12 +02:00
|
|
|
|
|
|
|
/**
|
2022-10-24 12:02:16 +02:00
|
|
|
* Returns the languages directory path for a specific domain and locale.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @param string $locale Locale.
|
|
|
|
*
|
|
|
|
* @return string|false MO file path or false if there is none available.
|
|
|
|
*/
|
|
|
|
public function get( $domain, $locale ) {
|
|
|
|
if ( isset( $this->all[ $domain ][ $locale ] ) ) {
|
|
|
|
return $this->all[ $domain ][ $locale ];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->get_path_from_lang_dir( $domain, $locale );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Determines whether any MO file paths are available for the domain.
|
|
|
|
*
|
2022-10-24 12:02:16 +02:00
|
|
|
* This is the case if a path has been set for the current locale,
|
|
|
|
* or if there is no information stored yet, in which case
|
|
|
|
* {@see _load_textdomain_just_in_time()} will fetch the information first.
|
|
|
|
*
|
2022-08-11 14:39:12 +02:00
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @return bool Whether any MO file paths are available for the domain.
|
|
|
|
*/
|
|
|
|
public function has( $domain ) {
|
2022-12-20 16:12:11 +01:00
|
|
|
return (
|
|
|
|
! empty( $this->current[ $domain ] ) ||
|
|
|
|
empty( $this->all[ $domain ] ) ||
|
|
|
|
in_array( $domain, $this->domains_with_translations, true )
|
|
|
|
);
|
2022-08-11 14:39:12 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-10-24 12:02:16 +02:00
|
|
|
* Sets the language directory path for a specific domain and locale.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
|
|
|
* Also sets the 'current' property for direct access
|
|
|
|
* to the path for the current (most recent) locale.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @param string $locale Locale.
|
|
|
|
* @param string|false $path Language directory path or false if there is none available.
|
|
|
|
*/
|
|
|
|
public function set( $domain, $locale, $path ) {
|
2023-02-09 17:35:22 +01:00
|
|
|
$this->all[ $domain ][ $locale ] = $path ? rtrim( $path, '/' ) . '/' : false;
|
2022-08-11 14:39:12 +02:00
|
|
|
$this->current[ $domain ] = $this->all[ $domain ][ $locale ];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-10-24 12:02:16 +02:00
|
|
|
* Sets the custom path to the plugin's/theme's languages directory.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
2022-10-24 12:02:16 +02:00
|
|
|
* Used by {@see load_plugin_textdomain()} and {@see load_theme_textdomain()}.
|
|
|
|
*
|
2022-12-20 16:12:11 +01:00
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2022-10-24 12:02:16 +02:00
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @param string $path Language directory path.
|
2022-08-11 14:39:12 +02:00
|
|
|
*/
|
2022-10-24 12:02:16 +02:00
|
|
|
public function set_custom_path( $domain, $path ) {
|
2023-02-09 17:35:22 +01:00
|
|
|
$this->custom_paths[ $domain ] = rtrim( $path, '/' );
|
2022-08-11 14:39:12 +02:00
|
|
|
}
|
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
/**
|
|
|
|
* Returns possible language directory paths for a given text domain.
|
|
|
|
*
|
|
|
|
* @since 6.1.2
|
|
|
|
*
|
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @return string[] Array of language directory paths.
|
|
|
|
*/
|
|
|
|
private function get_paths_for_domain( $domain ) {
|
|
|
|
$locations = array(
|
|
|
|
WP_LANG_DIR . '/plugins',
|
|
|
|
WP_LANG_DIR . '/themes',
|
|
|
|
);
|
|
|
|
|
|
|
|
if ( isset( $this->custom_paths[ $domain ] ) ) {
|
|
|
|
$locations[] = $this->custom_paths[ $domain ];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $locations;
|
|
|
|
}
|
|
|
|
|
2022-08-11 14:39:12 +02:00
|
|
|
/**
|
2022-10-24 12:02:16 +02:00
|
|
|
* Gets the path to the language directory for the current locale.
|
|
|
|
*
|
|
|
|
* Checks the plugins and themes language directories as well as any
|
|
|
|
* custom directory set via {@see load_plugin_textdomain()} or {@see load_theme_textdomain()}.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2022-10-24 12:02:16 +02:00
|
|
|
* @see _get_path_to_translation_from_lang_dir()
|
|
|
|
*
|
2022-08-11 14:39:12 +02:00
|
|
|
* @param string $domain Text domain.
|
|
|
|
* @param string $locale Locale.
|
2022-10-24 12:02:16 +02:00
|
|
|
* @return string|false Language directory path or false if there is none available.
|
2022-08-11 14:39:12 +02:00
|
|
|
*/
|
|
|
|
private function get_path_from_lang_dir( $domain, $locale ) {
|
2022-12-20 16:12:11 +01:00
|
|
|
$locations = $this->get_paths_for_domain( $domain );
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
$found_location = false;
|
2022-10-24 12:02:16 +02:00
|
|
|
|
|
|
|
foreach ( $locations as $location ) {
|
|
|
|
if ( ! isset( $this->cached_mo_files[ $location ] ) ) {
|
|
|
|
$this->set_cached_mo_files( $location );
|
|
|
|
}
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
$path = "$location/$domain-$locale.mo";
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
foreach ( $this->cached_mo_files[ $location ] as $mo_path ) {
|
|
|
|
if (
|
|
|
|
! in_array( $domain, $this->domains_with_translations, true ) &&
|
|
|
|
str_starts_with( str_replace( "$location/", '', $mo_path ), "$domain-" )
|
|
|
|
) {
|
|
|
|
$this->domains_with_translations[] = $domain;
|
|
|
|
}
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
if ( $mo_path === $path ) {
|
2023-02-09 17:35:22 +01:00
|
|
|
$found_location = rtrim( $location, '/' ) . '/';
|
2022-12-20 16:12:11 +01:00
|
|
|
}
|
2022-10-24 12:02:16 +02:00
|
|
|
}
|
2022-08-11 14:39:12 +02:00
|
|
|
}
|
|
|
|
|
2022-12-20 16:12:11 +01:00
|
|
|
if ( $found_location ) {
|
|
|
|
$this->set( $domain, $locale, $found_location );
|
|
|
|
|
|
|
|
return $found_location;
|
|
|
|
}
|
|
|
|
|
2022-10-24 12:02:16 +02:00
|
|
|
// If no path is found for the given locale and a custom path has been set
|
|
|
|
// using load_plugin_textdomain/load_theme_textdomain, use that one.
|
|
|
|
if ( 'en_US' !== $locale && isset( $this->custom_paths[ $domain ] ) ) {
|
2023-02-09 17:35:22 +01:00
|
|
|
$fallback_location = rtrim( $this->custom_paths[ $domain ], '/' ) . '/';
|
2022-12-20 16:12:11 +01:00
|
|
|
$this->set( $domain, $locale, $fallback_location );
|
|
|
|
return $fallback_location;
|
2022-08-11 14:39:12 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
$this->set( $domain, $locale, false );
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-10-24 12:02:16 +02:00
|
|
|
* Reads and caches all available MO files from a given directory.
|
2022-08-11 14:39:12 +02:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
2022-10-24 12:02:16 +02:00
|
|
|
*
|
|
|
|
* @param string $path Language directory path.
|
2022-08-11 14:39:12 +02:00
|
|
|
*/
|
2022-10-24 12:02:16 +02:00
|
|
|
private function set_cached_mo_files( $path ) {
|
|
|
|
$this->cached_mo_files[ $path ] = array();
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-10-24 12:02:16 +02:00
|
|
|
$mo_files = glob( $path . '/*.mo' );
|
2022-08-11 14:39:12 +02:00
|
|
|
|
2022-10-24 12:02:16 +02:00
|
|
|
if ( $mo_files ) {
|
|
|
|
$this->cached_mo_files[ $path ] = $mo_files;
|
2022-08-11 14:39:12 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|