Changeset 28724

Timestamp:

06/10/2014 06:45:38 AM (10 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for the wp_spaces_regexp filter.

Fixes #27588.

File:

• trunk/src/wp-includes/formatting.php (modified) (1 diff)

trunk/src/wp-includes/formatting.php

@@ -3878 +3878 @@
     if ( empty( $spaces ) ) {
         /**
-         * Regexp for common whitespace characters.
+         * Filter the regexp for common whitespace characters.
          *
-         * This string is substituted for the \s sequence as needed in regular expressions.
-         * For websites not written in English, different characters may represent whitespace.
-         * For websites not encoded in UTF-8, the 0xC2 0xA0 sequence may not be in use.
+         * This string is substituted for the \s sequence as needed in regular
+         * expressions. For websites not written in English, different characters
+         * may represent whitespace. For websites not encoded in UTF-8, the 0xC2 0xA0
+         * sequence may not be in use.
          *
          * @since 4.0.0
          *
-         * @param string $spaces
+         * @param string $spaces Regexp pattern for matching common whitespace characters.
          */
         $spaces = apply_filters( 'wp_spaces_regexp', '[\r\n\t ]|\xC2\xA0| ' );