Parameters
$args
arrayoptional- Arguments array, supports the following keys:
singular
stringThe string to translate, if omitted an empty entry will be created.plural
stringThe plural form of the string, setting this will set$is_plural
to true.translations
arrayTranslations of the string and possibly its plural forms.context
stringA string differentiating two equal strings used in different contexts.translator_comments
stringComments left by translators.extracted_comments
stringComments left by developers.references
arrayPlaces in the code this string is used, in relative_to_root_path/file.php:linenum form.flags
arrayFlags like php-format.
Default:
array()
Source
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();
}
}
User Contributed Notes
You must log in before being able to contribute a note or feedback.