Ticket #42725: 42725.diff

wp-includes/l10n.php

@@ -340 +340 @@
         return esc_html( translate_with_gettext_context( $text, $context, $domain ) );
 }
 
+/**
+ * Translates a string based on the gender pronouns passed to it.
+ * 
+ * This function takes a string with an expected a placeholder to be
+ * swapped out with a gender specific pronoun which would allow for
+ * strings to change to cater towards the user's gender.
+ * 
+ * Examples of using `_g` to use correct gender based pronouns.
+ * 
+ * Male: He was editing the post.
+ * Female: She is creating a new taxonomy.
+ * Other: They have activated a plugin.
+ * 
+ * @since 4.9
+ * 
+ * @param string $text    The text to translate.
+ * @param string $male    Male string version.
+ * @param string $female  Female string version.
+ * @param string $other   Non-specific gender version.
+ * @param int    $user_id The user's id.
+ * @param string $domain  The text domain.
+ * 
+ * @return string The translated string with gender.
+ */
+function _g( $text, $male, $female, $other, $user_id = 0, $domain = 'default' ) {
+
+        // Check if the user id was set.
+        if ( 0 == $user_id ) {
+                $user_id = get_current_user_id();
+        }
+
+        // Get the users gender preference.
+        $get_gender = get_user_meta($user_id, 'gender', true);
+
+        // Translate each string that is provided.
+        $translate_text = translate( $text, $domain );
+        $translate_male = translate( $male, $domain );
+        $translate_female = translate( $female, $domain );
+        $translate_other = translate( $other, $domain );
+
+        // Check which gender is selected.
+        if ( 'male' == $get_gender ) {
+                $the_gender = $translate_male;
+        } elseif ( 'female' == $user_gender ) {
+                $the_gender = $translate_female;
+        } else {
+                $the_gender = $translate_other;
+        }
+
+        // Add the gender string to the main string.
+        $string = sprintf( $translate_text, $the_gender );
+
+        // Return string for output.
+        return $string
+
+}
+
 /**
  * Translates and retrieves the singular or plural form based on the supplied number.
  *