Repository navigation
php-format comment missing #427
Description
Bug Report
- Yes, I reviewed the contribution guidelines.
- Yes, more specifically, I reviewed the guidelines on how to write clear bug reports.
Describe the current, buggy behavior
The
#, php-format
comment is not added (anymore?) when running wp i18n make-pot
#121 (comment) provides an example where it should exist, but it seems only the plural issue was fixed there, but the "php-format" comment is/was still missing.
Describe how other contributors can replicate this bug
wp i18n make-pot for printf( _n( '%d cat', '%d cats', 1, 'foo' ), 1 );
See correct results with:
xgettext test.php for
<?php
printf( ngettext( '%d cat', '%d cats', 1 ), 1 );
Describe what you would expect as the correct outcome
#: test.php:2
#, php-format
msgid "%d cat"
msgid_plural "%d cats"
msgstr[0] ""
msgstr[1] ""
Let us know what environment you are running this on
WP-CLI version: 2.11.0
Provide a possible solution
If there is a placeholder add the php-format comment (like it's already done for the "translators:" anyway, so in those cases + those where we don't have a translators comment)
Activity
swissspidy commentedon Feb 4, 2025
I don‘t recall ever adding this, so this was never there. It‘s specifically for xgettext/msgfmt. From the docs:
From what I can see in the msgfmt code at first glance, it checks whether singular&plurals have the same amount of formats and whether those are valid.
I don’t think we really need this for WordPress translations though… GlotPress doesn‘t use this and has its own validation for things like incorrect number of placeholders.
Using this command here with msgfmt is also unlikely, and I don‘t see us adding similar validation to the make-mo command….
Curious to learn about your use case though!
kkmuffme commentedon Feb 4, 2025
Exactly that's what it would be useful for. Right now we have a custom post-processor to check those, however it would be much better if translators would get an error in their translation tool right away.
Lots of plugins use that actually instead of the wp-cli commands for po/mo
swissspidy commentedon Feb 4, 2025
Hmm okay, well I guess it would be relatively easy to add, so PRs welcome :)
We already have
SPRINTF_PLACEHOLDER_REGEXinMakePotCommand, so inPhpFunctionsScannerandJsFunctionsScannerwe can check the extracted strings for placeholders and then do$translation->addFlag( 'php-format' ). This should be easy to add tests for too.This should help with anyone using
msgfmt.Ideally we add some validation logic to
make-moandmake-phpas well. We already do some validation inmake-pot(seeaudit_strings()method, which we could extract into a reusable trait.