Changeset 27739

Timestamp:

03/26/2014 02:56:04 PM (13 years ago)

Author:

nacin

Message:

Inline documentation for hooks in wp-includes/kses.php.

props siobhyb, DrewAPicture.
fixes #25800.

File:

• trunk/src/wp-includes/kses.php (modified) (4 diffs)

trunk/src/wp-includes/kses.php

@@ -502 +502 @@
         global $allowedposttags, $allowedtags, $allowedentitynames;
 
-        if ( is_array( $context ) )
+        if ( is_array( $context ) ) {
+                /**
+                 * Filter HTML elements allowed for a given context.
+                 *
+                 * @since 3.5.0
+                 *
+                 * @param string $tags    Allowed tags, attributes, and/or entities.
+                 * @param string $context Context to judge allowed tags by. Allowed values are 'post',
+                 *                        'data', 'strip', 'entities', 'explicit', or the name of a filter.
+                 */
                 return apply_filters( 'wp_kses_allowed_html', $context, 'explicit' );
+        }
 
         switch ( $context ) {
                 case 'post':
+                        /** This filter is documented in wp-includes/kses.php */
                         return apply_filters( 'wp_kses_allowed_html', $allowedposttags, $context );
                         break;
@@ -513 +524 @@
                         $tags = $allowedtags;
                         $tags['a']['rel'] = true;
+                        /** This filter is documented in wp-includes/kses.php */
                         return apply_filters( 'wp_kses_allowed_html', $tags, $context );
                         break;
                 case 'strip':
+                        /** This filter is documented in wp-includes/kses.php */
                         return apply_filters( 'wp_kses_allowed_html', array(), $context );
                         break;
                 case 'entities':
+                        /** This filter is documented in wp-includes/kses.php */
                         return apply_filters( 'wp_kses_allowed_html', $allowedentitynames, $context);
                         break;
                 case 'data':
                 default:
+                        /** This filter is documented in wp-includes/kses.php */
                         return apply_filters( 'wp_kses_allowed_html', $allowedtags, $context );
         }
@@ -541 +556 @@
  */
 function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
-        $string = apply_filters('pre_kses', $string, $allowed_html, $allowed_protocols);
+        /**
+         * Filter content to be run through kses.
+         *
+         * @since 2.3.0
+         *
+         * @param string $string            Content to run through kses.
+         * @param array  $allowed_html      Allowed HTML elements.
+         * @param array  $allowed_protocols Allowed protocol in links.
+         */
+        $string = apply_filters( 'pre_kses', $string, $allowed_html, $allowed_protocols );
         return $string;
 }
@@ -1415 +1439 @@
 
         $css_array = explode( ';', trim( $css ) );
+
+        /**
+         * Filter list of allowed CSS attributes.
+         *
+         * @since 2.8.1
+         *
+         * @param array $attr List of allowed CSS attributes.
+         */
         $allowed_attr = apply_filters( 'safe_style_css', array( 'text-align', 'margin', 'color', 'float',
         'border', 'background', 'background-color', 'border-bottom', 'border-bottom-color',