Hook Docs: wp-includes/l10n.php

[Nao]

The attached patch adds inline documentation for these hooks.

Filters:
locale
gettext
gettext_with_context
ngettext
ngettext_with_context
override_load_textdomain
load_textdomain_mofile
override_unload_textdomain
theme_locale

[DrewAPicture]

Hi Nao,

25382.diff​ is really close to ready, just a few tweaks:

• Looks like you missed a @param description for for the plugin_locale and theme_locale filters
• Change "Optional. Unique identifier for retrieving translated strings." to "Optional. Text domain. Unique identifier for retrieving translated strings." since we're preparing to change it through the rest of the file anyway
• Closing */ on each block needs to be indented once space
• Would you mind spacing out the docblocks everywhere the way you did for the gettext and gettext_with_context filters? It really improves readability

I think with those tweaks above this will be ready to go in. Thanks for the patch!

[Nao]

Thanks for your review, Drew. Attached is my revised patch based on your feedback.

[DrewAPicture]

With functional doc changes removed

[DrewAPicture]

25382.2.diff​ looks good to me.

[DrewAPicture]

Documents two actions that were missed

[DrewAPicture]

In 25565:

Inline documentation for hooks in wp-includes/l10n.php.

Props Nao.
Fixes #25382.