Changeset 58009 for trunk/src/wp-includes/l10n/class-wp-translation-controller.php

Timestamp:

04/15/2024 08:01:03 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Fix implicit nullable parameter type deprecation on PHP 8.4.

In PHP 8.4, declaring function or method parameters with a default value of null is deprecated if the type is not nullable.

PHP applications are recommended to explicitly declare the type as nullable. All type declarations that have a default value of null, but without declaring null in the type declaration, will emit a deprecation notice:

function test( array $value = null ) {}

Deprecated: Implicitly marking parameter $value as nullable is deprecated, the explicit nullable type must be used instead

Recommended Changes

Change the implicit nullable type declaration to a nullable type declaration, available since PHP 7.1:

- function test( string $test = null ) {}
+ function test( ?string $test = null ) {}

This commit updates the affected instances in core to use a nullable type declaration.

References:

• ​PHP RFC: Deprecate implicitly nullable parameter types
• ​PHP.Watch: PHP 8.4: Implicitly nullable parameter declarations deprecated

Follow-up to [28731], [50552], [57337], [57985].

Props ayeshrajans, jrf, audrasjb, jorbin.
Fixes #60786.

File:

• trunk/src/wp-includes/l10n/class-wp-translation-controller.php (modified) (8 diffs)

trunk/src/wp-includes/l10n/class-wp-translation-controller.php

@@ -99 +99 @@
      * @return bool True on success, false otherwise.
      */
-    public function load_file( string $translation_file, string $textdomain = 'default', string $locale = null ): bool {
+    public function load_file( string $translation_file, string $textdomain = 'default', ?string $locale = null ): bool {
         if ( null === $locale ) {
             $locale = $this->current_locale;
@@ -154 +154 @@
      * @return bool True on success, false otherwise.
      */
-    public function unload_file( $file, string $textdomain = 'default', string $locale = null ): bool {
+    public function unload_file( $file, string $textdomain = 'default', ?string $locale = null ): bool {
         if ( is_string( $file ) ) {
             $file = realpath( $file );
@@ -199 +199 @@
      * @return bool True on success, false otherwise.
      */
-    public function unload_textdomain( string $textdomain = 'default', string $locale = null ): bool {
+    public function unload_textdomain( string $textdomain = 'default', ?string $locale = null ): bool {
         $unloaded = false;
 
@@ -241 +241 @@
      * @return bool True if there are any loaded translations, false otherwise.
      */
-    public function is_textdomain_loaded( string $textdomain = 'default', string $locale = null ): bool {
+    public function is_textdomain_loaded( string $textdomain = 'default', ?string $locale = null ): bool {
         if ( null === $locale ) {
             $locale = $this->current_locale;
@@ -261 +261 @@
      * @return string|false Translation on success, false otherwise.
      */
-    public function translate( string $text, string $context = '', string $textdomain = 'default', string $locale = null ) {
+    public function translate( string $text, string $context = '', string $textdomain = 'default', ?string $locale = null ) {
         if ( '' !== $context ) {
             $context .= "\4";
@@ -295 +295 @@
      * @return string|false Translation on success, false otherwise.
      */
-    public function translate_plural( array $plurals, int $number, string $context = '', string $textdomain = 'default', string $locale = null ) {
+    public function translate_plural( array $plurals, int $number, string $context = '', string $textdomain = 'default', ?string $locale = null ) {
         if ( '' !== $context ) {
             $context .= "\4";
@@ -395 +395 @@
      * }
      */
-    protected function locate_translation( string $singular, string $textdomain = 'default', string $locale = null ) {
+    protected function locate_translation( string $singular, string $textdomain = 'default', ?string $locale = null ) {
         if ( array() === $this->loaded_translations ) {
             return false;
@@ -428 +428 @@
      * @return WP_Translation_File[] List of translation files.
      */
-    protected function get_files( string $textdomain = 'default', string $locale = null ): array {
+    protected function get_files( string $textdomain = 'default', ?string $locale = null ): array {
         if ( null === $locale ) {
             $locale = $this->current_locale;