Translation_Entry::__construct( array $args = array() )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Arguments array, supports the following keys: @type string $singular The string to translate, if omitted an empty entry will be created.Default: array()

• $pluralstring

  The plural form of the string, setting this will set $is_plural to true.

• $translationsarray

  Translations of the string and possibly its plural forms.

• $contextstring

  A string differentiating two equal strings used in different contexts.

• $translator_commentsstring

  Comments left by translators.

• $extracted_commentsstring

  Comments left by developers.

• $referencesarray

  Places in the code this string is used, in relative_to_root_path/file.php:linenum form.

• $flagsarray

  Flags like php-format.

Performance profile

How much work a call to Translation_Entry::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

4–28

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 33.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

8

8 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost Translation_Entry::__construct() can have, taken from its control-flow graph on PHP 8.5.

Used by · 8

• MO::make_entry()Build a Translation_Entry from original string and translation strings, found in a MO file
• PO::read_entry()
• Translation_Entry::Translation_Entry()PHP4 constructor.
• Translations::add_entry()Adds an entry to the PO structure.
• Translations::add_entry_or_merge()Adds or merges an entry to the PO structure.
• Translations::translate()Translates a singular string.
• Translations::translate_plural()Translates a plural string.
• WP_Translations::make_entry()Builds a Translation_Entry from original string and translation strings.

Source code

View on Trac ↗View on GitHub ↗

54		public function __construct( $args = array() ) {55			// If no singular -- empty object.56			if ( ! isset( $args['singular'] ) ) {57				return;58			}59			// Get member variable values from args hash.60			foreach ( $args as $varname => $value ) {61				$this->$varname = $value;62			}63			if ( isset( $args['plural'] ) && $args['plural'] ) {64				$this->is_plural = true;65			}66			if ( ! is_array( $this->translations ) ) {67				$this->translations = array();68			}69			if ( ! is_array( $this->references ) ) {70				$this->references = array();71			}72			if ( ! is_array( $this->flags ) ) {73				$this->flags = array();74			}75		}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/pomo/entry.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.