Changeset 33225 for trunk/src/wp-includes/formatting.php

Timestamp:

07/13/2015 09:29:35 PM (9 years ago)

Author:

DrewAPicture

Message:

Fix inline documentation syntax for two formatting functions added in 4.3.

• wptexturize_primes() See [32863]
• format_for_editor() See [32899]

See #32891.

File:

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

trunk/src/wp-includes/formatting.php

@@ -323 +323 @@
  * @since 4.3.0
  *
- * @param string $haystack The plain text to be searched.
- * @param string $needle The character to search for such as ' or ".
- * @param string $prime The prime char to use for replacement.
- * @param string $open_quote The opening quote char. Opening quote replacement must be accomplished already.
+ * @param string $haystack    The plain text to be searched.
+ * @param string $needle      The character to search for such as ' or ".
+ * @param string $prime       The prime char to use for replacement.
+ * @param string $open_quote  The opening quote char. Opening quote replacement must be
+ *                            accomplished already.
  * @param string $close_quote The closing quote char to use for replacement.
  * @return string The $haystack value after primes and quotes replacements.
@@ -3079 +3080 @@
  * it is still a good idea to HTML entity encode `<`, `>` and `&` in the content.
  *
- * The filter 'format_for_editor' is applied here. If $text is empty the filter will
- * be applied to an empty string.
+ * The filter {@see 'format_for_editor'} is applied here. If `$text` is empty the
+ * filter will be applied to an empty string.
  *
  * @since 4.3.0