Encourage community translations for WordPress.org plugins

Plugins and themes hosted on WordPress.org are, as of December 5th(-ish) 2015, translateable through translate.wordpress.org.

This opens up for a lot of interesting new interactions for existing, and potential new users, who may not be fluent in English, and have not yet picked up your plugin or theme for this reason alone.

So, your plugin is now up there, it can be translated…but how do you encourage your users to participate and translate the plugin?

I threw together a snippet for just this purpose, it may not be for everyone, but I do believe it’s a fairly safe starting point for most people.

The code requires some minor edits before you use it (technically only one edit is required, the text_domain one);

  • $plugin_slug in the get_option and update_option calls should reflect your own plugins slug
  • $text_domain needs to match your plugin slug (adn the langauge path ideally, just like your normal textdomain loading function)

The snippet follows the plugin guidelines for nag screens (dismissable and will stay dismissed, yay!), so you can use it as is, or you can modify it (it’s just a way to get the ball rolling really).

 

Caveats (before you say it’s broken);

  • The code must be in your main plugin file, this is due to the get_plugin_data call being used
  • The nag screen is per language, so if the user changes their language, they’ll get a new nag screen (possible yay, possible nay?)
  • No nag screen is shown if a translation file actually exists for the current language, if so the nag screen is automatically disabled

I also added in text domains to the nag message, this is so you can utilize it even if you decide to remove the disable nag checker, and want to display a translated message to your users, one idea here is to show a “You’ve used this plugin for 1 week, please consider helping with translations” kind of message, or any other approach you feel is valid.

3 thoughts on “Encourage community translations for WordPress.org plugins”

  1. this is very interesting, Marius, and i am sure that it will be most useful to me.

    I wonder if you might also have some small snippet or plugin which will gather statistics for me on how many users from each different languages / locales have either downloaded or are using my plugins? Unfortunately WordPress.org seems to give me statistics only for total user downloads without telling me the totals per the locales of those people.

    Regards,

    François

    1. You could do it by providing an opt-in stats gathering element to your plugin and sending the data your self (I’d send the locale and URL so you can distinguish between sites if you go this route).

      The stats on WordPress.org may improve over time though, the plugin directory is at this time undergoing an overhaul which will make enhancements easier to do with time, you could drop by then they have their chats and see what plans they have in regard to this (they meet on Thursdays in the #meta room on Slack – https://make.wordpress.org/meta/tag/plugin-directory/)

      1. Hello Marius,

        Many thanks for your prompt response and useful suggestions. I will certainly look into these.

        With a bit of luck the WP organizers and developers will implement such a functionality anyway in the near future, thus save the rest us from needing to come up with our own stats-gathering extension of our plugins.

        By the way, I really like your plugin ‘String Locator’, which is ideal for addressing a need I frequently experience.

        Keep up the good work 😉

        François

Leave a Reply

Your email address will not be published. Required fields are marked *