Changeset 30546 for trunk/src/wp-includes/wp-db.php

Timestamp:

11/24/2014 06:30:19 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 code snippets in the description for get_object_taxonomies()
• Backtick-escape inline code in a markdown-formatted unordered list in the description for get_taxonomy_labels()
• Remove an HTML tag from the summary for the Walker_Category_Checklist class
• Remove an HTML tag from the summary for wp_category_checklist(), various formatting
• Remove an HTML tag from the summary for wp_terms_checklist()
• Backtick-escape an HTML tag in the description for wp_popular_terms_checklist()
• Remove HTML tags from the summaries for page_template_dropdown(), parent_dropdown(), and wp_dropdown_roles()
• Backtick-escape HTML tags in a parameter description for add_settings_error()
• Various formatting in the description and summary for settings_errors()
• Markdown-indent code snippets in the descriptions for wpdb::prepare(), wpdb::insert(), wpdb::replace(), wpdb::update(), and wpdb::delete()
• Backtick-escape an HTML tag in a parameter description for login_header()
• Remove HTML tags from the summaries for the lostpassword_form and signup_header hooks

Props rarst.
See #30473.

File:

• trunk/src/wp-includes/wp-db.php (modified) (5 diffs)

trunk/src/wp-includes/wp-db.php

@@ -1173 +1173 @@
      * Both %d and %s should be left unquoted in the query string.
      *
-     * <code>
-     * wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 )
-     * wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
-     * </code>
+     *     wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 )
+     *     wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
      *
      * @link http://php.net/sprintf Description of syntax.
@@ -1725 +1723 @@
      * Insert a row into a table.
      *
-     * <code>
-     * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
-     * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
-     * </code>
+     *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
+     *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
      *
      * @since 2.5.0
@@ -1748 +1744 @@
      * Replace a row into a table.
      *
-     * <code>
-     * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
-     * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
-     * </code>
+     *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
+     *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
      *
      * @since 3.0.0
@@ -1815 +1809 @@
      * Update a row in the table
      *
-     * <code>
-     * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
-     * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
-     * </code>
+     *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
+     *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
      *
      * @since 2.5.0
@@ -1869 +1861 @@
      * Delete a row in the table
      *
-     * <code>
-     * wpdb::delete( 'table', array( 'ID' => 1 ) )
-     * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
-     * </code>
+     *     wpdb::delete( 'table', array( 'ID' => 1 ) )
+     *     wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
      *
      * @since 3.4.0