Changeset 30545 for trunk/src/wp-includes/shortcodes.php

Timestamp:

11/24/2014 06:14:03 AM (10 years ago)

Author:

DrewAPicture

Message:

Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

• Backtick-escape HTML tags in several argument descriptions for wp_link_pages()
• Remove an HTML tag from the summary for prepend_attachment()
• Backtick-escape inline code in the description for get_extended()
• Backtick-escape inline code in the description for get_post_type_labels()
• Various markdown formatting in the description for add_rewrite_endpoint()
• Markdown-indent a code snippet in the file header for wp-includes/shortcodes.php
• Markdown-indent code snippets in the description for `add_shortcode()

Props rarst.
See #30473.

File:

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

trunk/src/wp-includes/shortcodes.php

@@ -22 +22 @@
  * To apply shortcode tags to content:
  *
- * <code>
- * $out = do_shortcode($content);
- * </code>
+ *     $out = do_shortcode( $content );
  *
  * @link http://codex.wordpress.org/Shortcode_API
@@ -53 +51 @@
  * Simplest example of a shortcode tag using the API:
  *
- * <code>
- * // [footag foo="bar"]
- * function footag_func($atts) {
- *  return "foo = {$atts[foo]}";
- * }
- * add_shortcode('footag', 'footag_func');
- * </code>
+ *     // [footag foo="bar"]
+ *     function footag_func( $atts ) {
+ *         return "foo = {
+ *             $atts[foo]
+ *         }";
+ *     }
+ *     add_shortcode( 'footag', 'footag_func' );
  *
  * Example with nice attribute defaults:
  *
- * <code>
- * // [bartag foo="bar"]
- * function bartag_func($atts) {
- *  $args = shortcode_atts(array(
- *      'foo' => 'no foo',
- *      'baz' => 'default baz',
- *  ), $atts);
- *
- *  return "foo = {$args['foo']}";
- * }
- * add_shortcode('bartag', 'bartag_func');
- * </code>
+ *     // [bartag foo="bar"]
+ *     function bartag_func( $atts ) {
+ *         $args = shortcode_atts( array(
+ *             'foo' => 'no foo',
+ *             'baz' => 'default baz',
+ *         ), $atts );
+ *
+ *         return "foo = {$args['foo']}";
+ *     }
+ *     add_shortcode( 'bartag', 'bartag_func' );
  *
  * Example with enclosed content:
  *
- * <code>
- * // [baztag]content[/baztag]
- * function baztag_func($atts, $content='') {
- *  return "content = $content";
- * }
- * add_shortcode('baztag', 'baztag_func');
- * </code>
+ *     // [baztag]content[/baztag]
+ *     function baztag_func( $atts, $content = '' ) {
+ *         return "content = $content";
+ *     }
+ *     add_shortcode( 'baztag', 'baztag_func' );
  *
  * @since 2.5.0