Translatability fixes

[benlk]

Changes

This pull request makes the following changes:

• reduces Largo to a single text domain: largo
• adds text domains to a whole heap of translation functions
• adds new translation to a few places
• removes some variables from translation strings, or removes the translation outright
• adds translators: notes for strings translated for use with sprintf/printf, based on the output of grunt pot

This PR does not include:

• an exhaustive search for cases where variables relevant to the translated text are appended to the translated text outside of the translation function, such as this example: <php echo esc_html__( 'My name is', 'largo' ); . ' ' . $name ?>

Why

For #1592 and INN/umbrella-caribbean#96

Testing/Questions

Features that this PR affects:

• internationalization

Questions that need to be answered before merging:

• Is this PR targeting the correct branch in this repository?
• Are there other errors of translation that need to be fixed?

Steps to test this PR:

1. Run grunt pot. Expect no error messages.
2. Run the Theme Check plugin against Largo. Expect no translation-related error messages other than those noted below.

WARNING: Found a translation function that is missing a text-domain. Function __, with the arguments 'largo'

I can't find this one. Good luck if you're going hunting.

$this->lib_e(

The theme check plugin appears to think lib_e is a translation function. It's not; these results are a false positive.

Possible variable $s found in translation function in inc/widgets/largo-twitter.php. Translation function calls must NOT contain PHP variables.

Line 34: __( '@%1$s's Likes on Twitter', 'largo' ),

That's the right format for passing a variable to sprintf, right?

[joshdarby]

Possible variable $s found in translation function in inc/widgets/largo-twitter.php. Translation function calls must NOT contain PHP variables.

Line 34: __( '@%1$s's Likes on Twitter', 'largo' ),

That's the right format for passing a variable to sprintf, right?

Yea. I think we can ignore this one because it thinks $s is a variable in this case even though it's not.

[joshdarby]

WARNING: Found a translation function that is missing a text-domain. Function __, with the arguments 'largo'

I can't find this one. Good luck if you're going hunting.

@benlk I went hunting and commented out all __ functions in inc/post-social.php and inc/widgets/largo-twitter.php and that removed the warning. Not sure why that warning is being thrown though because all cases have 2 args like they should

[joshdarby]

Seems to work as expected. 👍

[benlk]

commented out all __ functions in inc/post-social.php and inc/widgets/largo-twitter.php and that removed the warning

With the following comments, the warning goes away:

diff --git a/inc/post-social.php b/inc/post-social.php
index aad372cd..47c81099 100644
--- a/inc/post-social.php
+++ b/inc/post-social.php
@@ -34,11 +34,13 @@ if ( ! function_exists( 'largo_post_social_links' ) ) {
 
 		if ( isset( $utilities['facebook'] ) && '1' === $utilities['facebook'] ) {
 			$fb_share = '<span class="facebook"><a target="_blank" href="https://www.facebook.com/sharer/sharer.php?u=%1$s"><i class="icon-facebook"></i><span class="hidden-phone">%2$s</span></a></span>';
+			/*
 			$output .= sprintf(
 				$fb_share,
 				rawurlencode( get_permalink() ),
 				__( ucfirst( of_get_option( 'fb_verb' ) ), 'largo' )
 			);
+			*/
 		}
 
 		if ( isset( $utilities['twitter'] ) && '1' === $utilities['twitter'] ) {
diff --git a/inc/widgets/largo-twitter.php b/inc/widgets/largo-twitter.php
index fa41913f..129c815c 100644
--- a/inc/widgets/largo-twitter.php
+++ b/inc/widgets/largo-twitter.php
@@ -31,7 +31,7 @@ class largo_twitter_widget extends WP_Widget {
 				$widget_href = 'https://twitter.com/' . $instance['twitter_username'] . '/likes';
 				$widget_text = sprintf(
 					// translators: @username's Likes on Twitter.
-					__( "@%1$s's Likes on Twitter", 'largo' ),
+					// __( "@%1$s's Likes on Twitter", 'largo' ),
 					esc_html( $instance['twitter_username'] )
 				);
 				break;
@@ -39,7 +39,7 @@ class largo_twitter_widget extends WP_Widget {
 				$widget_href = 'https://twitter.com/' . $instance['twitter_username'] . '/lists/' . $instance['twitter_list_slug'];
 				$widget_text = sprintf(
 					/* translators: A Twitter List by [twitter user name] */
-					__( 'A Twitter List by %1$s', 'largo' ),
+					// __( 'A Twitter List by %1$s', 'largo' ),
 					$instance['twitter_username']
 				);
 				break;
@@ -52,7 +52,7 @@ class largo_twitter_widget extends WP_Widget {
 				/* translators: Tweets by @username */
 				$widget_text = sprintf(
 					// translators: %1$s is the twitter username
-					__( 'Tweets by @%1$s', 'largo' ),
+					// __( 'Tweets by @%1$s', 'largo' ),
 					esc_html( $instance['twitter_username'] )
 				);
 		}

It's tripping over:

• output of a function
• %1$s on a sprintf when there's only one argument to be interpolated

[benlk]

With those two latest commits, it now completes without those two error messages.