Skip to content

Commit

Permalink
Docs: Correct @param type for $deprecated and $plugin_rel_path
Browse files Browse the repository at this point in the history
…arguments of `load_plugin_textdomain()`.

Props sudar.
Fixes #43304.

git-svn-id: https://develop.svn.wordpress.org/trunk@45254 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
SergeyBiryukov authored and SergeyBiryukov committed Apr 19, 2019
1 parent bc320e1 commit e06bb93
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/wp-includes/l10n.php
Original file line number Diff line number Diff line change
Expand Up @@ -767,10 +767,11 @@ function load_default_textdomain( $locale = null ) {
* @since 1.5.0
* @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Unique identifier for retrieving translated strings
* @param string $deprecated Optional. Use the $plugin_rel_path parameter instead. Default false.
* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
* Default false.
* @param string $domain Unique identifier for retrieving translated strings
* @param string|false $deprecated Optional. Deprecated. Use the $plugin_rel_path parameter instead.
* Default false.
* @param string|false $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
* Default false.
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
Expand Down

0 comments on commit e06bb93

Please sign in to comment.