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

Timestamp:

11/24/2014 06:14:03 AM (11 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/rewrite.php (modified) (2 diffs)

trunk/src/wp-includes/rewrite.php

@@ -227 +227 @@
  * places specified by the provided bitmask. For example:
  *
- * <code>
- * add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES );
- * </code>
+ *     add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES );
  *
  * will add a new rewrite rule ending with "json(/(.*))?/?$" for every permastruct
  * that describes a permalink (post) or page. This is rewritten to "json=$match"
  * where $match is the part of the URL matched by the endpoint regex (e.g. "foo" in
- * "<permalink>/json/foo/").
+ * "[permalink]/json/foo/").
  *
  * A new query var with the same name as the endpoint will also be created.
@@ -240 +238 @@
  * When specifying $places ensure that you are using the EP_* constants (or a
  * combination of them using the bitwise OR operator) as their values are not
- * guaranteed to remain static (especially EP_ALL).
- *
- * Be sure to flush the rewrite rules - flush_rewrite_rules() - when your plugin gets
+ * guaranteed to remain static (especially `EP_ALL`).
+ *
+ * Be sure to flush the rewrite rules - {@see flush_rewrite_rules()} - when your plugin gets
  * activated and deactivated.
  *