Changeset 49963 for trunk/src/wp-includes/l10n.php

Timestamp:

01/15/2021 08:06:50 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696], [47060], [49926], [49927], [49929].

See #51800.

File:

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

trunk/src/wp-includes/l10n.php

@@ -999 +999 @@
  * @param string $domain Optional. Text domain. Default 'default'.
  * @param string $path   Optional. The full file path to the directory containing translation files.
- * @return string|false False if the script textdomain could not be loaded, the translated strings
- *                      in JSON encoding otherwise.
+ * @return string|false The translated strings in JSON encoding on success,
+ *                      false if the script textdomain could not be loaded.
  */
 function load_script_textdomain( $handle, $domain = 'default', $path = null ) {
@@ -1130 +1130 @@
  * @param string       $handle Name of the script to register a translation domain to.
  * @param string       $domain The text domain.
- * @return string|false The JSON-encoded translated strings for the given script handle and text domain. False if there are none.
+ * @return string|false The JSON-encoded translated strings for the given script handle and text domain.
+ *                      False if there are none.
  */
 function load_script_translations( $file, $handle, $domain ) {