Changeset 63323

Timestamp:

08/18/2026 11:44:01 AM (7 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing descriptions and declare types for Translation_Entry properties.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13126.

Follow-up to r10584, r32990, r57734.

Props pedromendonca, mukesh27, dhruvang21.
Fixes #65901.

File:

• trunk/src/wp-includes/pomo/entry.php (modified) (2 diffs)

trunk/src/wp-includes/pomo/entry.php

@@ -24 +24 @@
                 public $is_plural = false;
 
-                public $context             = null;
-                public $singular            = null;
-                public $plural              = null;
-                public $translations        = array();
-                public $translator_comments = '';
-                public $extracted_comments  = '';
-                public $references          = array();
-                public $flags               = array();
+                /**
+                 * The string to translate.
+                 *
+                 * @var string|null
+                 */
+                public $singular = null;
 
                 /**
+                 * The plural form of the string.
+                 *
+                 * @var string|null
+                 */
+                public $plural = null;
+
+                /**
+                 * Translations of the string and possibly its plural forms.
+                 *
+                 * Plural forms which have not been filled in are null.
+                 *
+                 * @var (string|null)[]
+                 */
+                public $translations = array();
+
+                /**
+                 * Context of the string, used to differentiate two equal strings used in different contexts.
+                 *
+                 * @var string|null
+                 */
+                public $context = null;
+
+                /**
+                 * Comments left by translators.
+                 *
+                 * @var string
+                 */
+                public $translator_comments = '';
+
+                /**
+                 * Comments left by developers.
+                 *
+                 * @var string
+                 */
+                public $extracted_comments = '';
+
+                /**
+                 * Places in the code this string is used, in relative_to_root_path/file.php:linenum form.
+                 *
+                 * @var string[]
+                 */
+                public $references = array();
+
+                /**
+                 * Flags like php-format.
+                 *
+                 * @var string[]
+                 */
+                public $flags = array();
+
+                /**
+                 * Constructor.
+                 *
+                 * @since 2.8.0
+                 *
                  * @param array $args {
-                 *     Arguments array, supports the following keys:
+                 *     Optional. Array of arguments. Default empty array.
                  *
-                 *     @type string $singular            The string to translate, if omitted an
-                 *                                       empty entry will be created.
-                 *     @type string $plural              The plural form of the string, setting
-                 *                                       this will set `$is_plural` to true.
-                 *     @type array  $translations        Translations of the string and possibly
-                 *                                       its plural forms.
-                 *     @type string $context             A string differentiating two equal strings
-                 *                                       used in different contexts.
-                 *     @type string $translator_comments Comments left by translators.
-                 *     @type string $extracted_comments  Comments left by developers.
-                 *     @type array  $references          Places in the code this string is used, in
-                 *                                       relative_to_root_path/file.php:linenum form.
-                 *     @type array  $flags               Flags like php-format.
+                 *     @type string          $singular            The string to translate, if omitted an
+                 *                                                empty entry will be created.
+                 *     @type string          $plural              The plural form of the string, setting
+                 *                                                this will set `$is_plural` to true.
+                 *     @type (string|null)[] $translations        Translations of the string and possibly
+                 *                                                its plural forms.
+                 *     @type string          $context             A string differentiating two equal strings
+                 *                                                used in different contexts.
+                 *     @type string          $translator_comments Comments left by translators.
+                 *     @type string          $extracted_comments  Comments left by developers.
+                 *     @type string[]        $references          Places in the code this string is used, in
+                 *                                                relative_to_root_path/file.php:linenum form.
+                 *     @type string[]        $flags               Flags like php-format.
                  * }
                  */
@@ -82 +135 @@
                  *
                  * @see Translation_Entry::__construct()
+                 *
+                 * @param array $args Optional. Array of arguments. Default empty array.
                  */
                 public function Translation_Entry( $args = array() ) {