Dynamic textdomain will not work #2

Activity

1. atimmer commented on Feb 23, 2017

   

   atimmer

   on Feb 23, 2017

   Last edited by atimmer

   Contributor

   More actions

   It does work this way right now for the license manager: https://github.com/Yoast/License-Manager/blob/master/class-product.php#L72. And the strings are picked up by makepot.php in wordpress-seo so that is the way we have done it previously. Yes gettext only works with a hardcoded textdomain, but makepot.php parses these anyway.

   I agree that this is not the most optimal way. How would you design the tooling around your first solution? The current way of translating is a pragmatic choice because it fits in the existing tooling.
2. schlessera commented on Feb 23, 2017

   

   schlessera

   on Feb 23, 2017

   ContributorAuthor

   More actions

   Something like this (coded in the GitHub comment box, so not tested or even sane in any way):

   <?php
   return array(
       // Message identifiers should be defined as interface constants somewhere.
       Whip_Message::MESSAGE_IDENTIFIER_1 => __( 'This is a localized string.', 'whip' ),
       Whip_Message::MESSAGE_IDENTIFIER_2 => __( 'This is another localized string.', 'whip' ),
       // [...]
   );

   Then, in the file where you want to make use of the messages:

   <?php
   // We can now inject a config.
   $default_config_path = dirname( __FILE__ ) . '/message_strings.php';
   $config_path = apply_filters( 'whip_config_path', $default_config_path );
   
   if ( ! is_readable( $config_path ) ) {
       $config_path = $default_config_path;
   }
   
   ob_start();
   include $config_path;
   $config = ob_get_clean();
   
   $php_messages = new PHPMessages( $config );
   $message = PHPMessages->get_from( $failed_requirement );
3. schlessera commented on Feb 23, 2017

   

   schlessera

   on Feb 23, 2017

   ContributorAuthor

   More actions

   If someone else wants to provide a different set of messages, they can provide an alternate config file (with their own textdomains) and inject it via the filter.

   Otherwise, every plugin will use the default messages with your whip textdomain, so that these only need to be translated once, instead of for every single plugin.
4. schlessera commented on Feb 23, 2017

   

   schlessera

   on Feb 23, 2017

   ContributorAuthor

   More actions

   You could even improve upon this and load both the default and the custom config and merge both, so you can only override the defaults partially, while still falling back to the defaults where you don't provide a custom config.
5. schlessera commented on Feb 23, 2017

   

   schlessera

   on Feb 23, 2017

   ContributorAuthor

   More actions

   To make the code cleaner, you can add a Config class that is responsible for loading (and optionally merging) config files.
6. schlessera commented on Feb 23, 2017

   

   schlessera

   on Feb 23, 2017

   Last edited by schlessera

   ContributorAuthor

   More actions

   See https://github.com/brightnucleus/config-52 for an extremely basic implementation, as inspiration.
   That one is PHP 5.2 compatible.
7. w3guy commented on Mar 6, 2017

   

   w3guy

   on Mar 6, 2017

   More actions

   I was exactly here to report same issue.
8. jrfnl

   added

   technical-debt

   on Oct 28, 2019