mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-11 23:28:18 +02:00
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
186 lines
4.4 KiB
PHP
186 lines
4.4 KiB
PHP
<?php
|
|
/**
|
|
* Locale API: WP_Textdomain_Registry class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage i18n
|
|
* @since 6.1.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used for registering text domains.
|
|
*
|
|
* @since 6.1.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
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();
|
|
|
|
/**
|
|
* Holds a cached list of available .mo files to improve performance.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $cached_mo_files;
|
|
|
|
/**
|
|
* Returns the MO file path for a specific domain and locale.
|
|
*
|
|
* @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.
|
|
*
|
|
* @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 ) {
|
|
return ! empty( $this->all[ $domain ] );
|
|
}
|
|
|
|
/**
|
|
* Returns the current (most recent) MO file path for a specific domain.
|
|
*
|
|
* @since 6.1.0
|
|
*
|
|
* @param string $domain Text domain.
|
|
* @return string|false Current MO file path or false if there is none available.
|
|
*/
|
|
public function get_current( $domain ) {
|
|
if ( isset( $this->current[ $domain ] ) ) {
|
|
return $this->current[ $domain ];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Sets the MO file path for a specific domain and locale.
|
|
*
|
|
* 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 ) {
|
|
$this->all[ $domain ][ $locale ] = $path ? trailingslashit( $path ) : false;
|
|
$this->current[ $domain ] = $this->all[ $domain ][ $locale ];
|
|
}
|
|
|
|
/**
|
|
* Resets the registry state.
|
|
*
|
|
* @since 6.1.0
|
|
*/
|
|
public function reset() {
|
|
$this->cached_mo_files = null;
|
|
$this->all = array();
|
|
$this->current = array();
|
|
}
|
|
|
|
/**
|
|
* Gets the path to a translation file in the languages directory for the current locale.
|
|
*
|
|
* @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.
|
|
*/
|
|
private function get_path_from_lang_dir( $domain, $locale ) {
|
|
if ( null === $this->cached_mo_files ) {
|
|
$this->set_cached_mo_files();
|
|
}
|
|
|
|
$mofile = "{$domain}-{$locale}.mo";
|
|
|
|
$path = WP_LANG_DIR . '/plugins/' . $mofile;
|
|
|
|
if ( in_array( $path, $this->cached_mo_files, true ) ) {
|
|
$path = WP_LANG_DIR . '/plugins/';
|
|
$this->set( $domain, $locale, $path );
|
|
|
|
return $path;
|
|
}
|
|
|
|
$path = WP_LANG_DIR . '/themes/' . $mofile;
|
|
if ( in_array( $path, $this->cached_mo_files, true ) ) {
|
|
$path = WP_LANG_DIR . '/themes/';
|
|
$this->set( $domain, $locale, $path );
|
|
|
|
return $path;
|
|
}
|
|
|
|
// If no path is found for the given locale, check if an entry for the default
|
|
// en_US locale exists. This is the case when e.g. using load_plugin_textdomain
|
|
// with a custom path.
|
|
if ( 'en_US' !== $locale && isset( $this->all[ $domain ]['en_US'] ) ) {
|
|
$this->set( $domain, $locale, $this->all[ $domain ]['en_US'] );
|
|
return $this->all[ $domain ]['en_US'];
|
|
}
|
|
|
|
$this->set( $domain, $locale, false );
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Reads and caches all available MO files from the plugins and themes language directories.
|
|
*
|
|
* @since 6.1.0
|
|
*/
|
|
protected function set_cached_mo_files() {
|
|
$this->cached_mo_files = array();
|
|
|
|
$locations = array(
|
|
WP_LANG_DIR . '/plugins',
|
|
WP_LANG_DIR . '/themes',
|
|
);
|
|
|
|
foreach ( $locations as $location ) {
|
|
$mo_files = glob( $location . '/*.mo' );
|
|
|
|
if ( $mo_files ) {
|
|
$this->cached_mo_files = array_merge( $this->cached_mo_files, $mo_files );
|
|
}
|
|
}
|
|
}
|
|
}
|