From 543dc8bef5e2493cee056d35f20e2df5cc0ac053 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 27 May 2016 17:16:27 +0000 Subject: [PATCH] Docs: Improve formatting in the DocBlock for `sanitize_bookmark_field()`. See #32246. Built from https://develop.svn.wordpress.org/trunk@37586 git-svn-id: http://core.svn.wordpress.org/trunk@37554 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/bookmark.php | 30 +++++++++++++++--------------- wp-includes/version.php | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/wp-includes/bookmark.php b/wp-includes/bookmark.php index 85142b2630..fc719d5898 100644 --- a/wp-includes/bookmark.php +++ b/wp-includes/bookmark.php @@ -336,26 +336,26 @@ function sanitize_bookmark($bookmark, $context = 'display') { * * Sanitizes the bookmark fields based on what the field name is. If the field * has a strict value set, then it will be tested for that, else a more generic - * filtering is applied. After the more strict filter is applied, if the - * $context is 'raw' then the value is immediately return. + * filtering is applied. After the more strict filter is applied, if the `$context` + * is 'raw' then the value is immediately return. * - * Hooks exist for the more generic cases. With the 'edit' context, the - * {@see 'edit_$field'} filter will be called and passed the `$value` and `$bookmark_id` - * respectively. With the 'db' context, the {@see 'pre_$field'} filter is called and - * passed the value. The 'display' context is the final context and has the - * `$field` has the filter name and is passed the `$value`, `$bookmark_id`, and - * `$context`, respectively. + * Hooks exist for the more generic cases. With the 'edit' context, the {@see 'edit_$field'} + * filter will be called and passed the `$value` and `$bookmark_id` respectively. + * + * With the 'db' context, the {@see 'pre_$field'} filter is called and passed the value. + * The 'display' context is the final context and has the `$field` has the filter name + * and is passed the `$value`, `$bookmark_id`, and `$context`, respectively. * * @since 2.3.0 * - * @param string $field The bookmark field - * @param mixed $value The bookmark field value - * @param int $bookmark_id Bookmark ID - * @param string $context How to filter the field value. Either 'raw', 'edit', - * 'attribute', 'js', 'db', or 'display' - * @return mixed The filtered value + * @param string $field The bookmark field. + * @param mixed $value The bookmark field value. + * @param int $bookmark_id Bookmark ID. + * @param string $context How to filter the field value. Accepts 'raw', 'edit', 'attribute', + * 'js', 'db', or 'display' + * @return mixed The filtered value. */ -function sanitize_bookmark_field($field, $value, $bookmark_id, $context) { +function sanitize_bookmark_field( $field, $value, $bookmark_id, $context ) { switch ( $field ) { case 'link_id' : // ints case 'link_rating' : diff --git a/wp-includes/version.php b/wp-includes/version.php index 88d62eccde..359200721a 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.6-alpha-37585'; +$wp_version = '4.6-alpha-37586'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.