Changeset 28924

Timestamp:

06/30/2014 01:51:11 PM (11 years ago)

Author:

SergeyBiryukov

Message:

Document @return value for load_plugin_textdomain(). props jdgrimes.

Document $path parameter for load_child_theme_textdomain().

fixes #28690.

File:

• trunk/src/wp-includes/l10n.php (modified) (2 diffs)

trunk/src/wp-includes/l10n.php

@@ -555 +555 @@
  * @param string $deprecated      Use the $plugin_rel_path parameter instead.
  * @param string $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 ) {
@@ -663 +665 @@
  *
  * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @param string $path   Optional. Path to the directory containing the .mo file.
+ *                       Default false.
  * @return bool True when the theme textdomain is successfully loaded, false otherwise.
  */