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

Timestamp:

06/10/2014 06:28:19 AM (10 years ago)

Author:

DrewAPicture

Message:

Add inline documentation for the run_wptexturize filter.

Props miqrogroove for the original patch.
Fixes #19550.

File:

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

trunk/src/wp-includes/formatting.php

@@ -38 +38 @@
     // No need to set up these static variables more than once
     if ( ! isset( $static_characters ) ) {
+        /**
+         * Filter whether to skip running `wptexturize()`.
+         *
+         * Passing false to the filter will effectively short-circuit `wptexturize()`.
+         * returning the original text passed to the function instead.
+         *
+         * The filter runs only once, the first time `wptexturize()` is called.
+         *
+         * @since 4.0.0
+         *
+         * @param bool $run_texturize Whether to short-circuit `wptexturize()`.
+         */
         $run_texturize = apply_filters( 'run_wptexturize', $run_texturize );
         if ( false === $run_texturize ) {