Translation_Entry::__construct() WordPress Method

The Translation_Entry::__construct() method is used to create a new translation entry object. This object can then be used to add or remove translation strings from the WordPress database.

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


Parameters

$args

(array)(Optional)Arguments array, supports the following keys:

  • 'singular'
    (string) The string to translate, if omitted an empty entry will be created.
  • 'plural'
    (string) The plural form of the string, setting this will set $is_plural to true.
  • 'translations'
    (array) Translations of the string and possibly its plural forms.
  • 'context'
    (string) A string differentiating two equal strings used in different contexts.
  • 'translator_comments'
    (string) Comments left by translators.
  • 'extracted_comments'
    (string) Comments left by developers.
  • 'references'
    (array) Places in the code this string is used, in relative_to_root_path/file.php:linenum form.
  • 'flags'
    (array) Flags like php-format.

Default value: array()


Top ↑

Source

File: wp-includes/pomo/entry.php

		public function __construct( $args = array() ) {
			// If no singular -- empty object.
			if ( ! isset( $args['singular'] ) ) {
				return;
			}
			// Get member variable values from args hash.
			foreach ( $args as $varname => $value ) {
				$this->$varname = $value;
			}
			if ( isset( $args['plural'] ) && $args['plural'] ) {
				$this->is_plural = true;
			}
			if ( ! is_array( $this->translations ) ) {
				$this->translations = array();
			}
			if ( ! is_array( $this->references ) ) {
				$this->references = array();
			}
			if ( ! is_array( $this->flags ) ) {
				$this->flags = array();
			}
		}

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.