Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-26 06:45:07 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Improve formatting in the DocBlock for sanitize_bookmark_field().

Browse Source 
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
This commit is contained in:
Drew Jaynes 2016-05-27 17:16:27 +00:00
parent 7b5364d2ec
commit 543dc8bef5
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
wp-includes/bookmark.php
View File

@ -336,26 +336,26 @@ function sanitize_bookmark($bookmark, $context = 'display') {
* *
* Sanitizes the bookmark fields based on what the field name is. If the field * 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 * 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 * filtering is applied. After the more strict filter is applied, if the `$context`
* $context is 'raw' then the value is immediately return. * is 'raw' then the value is immediately return.
* *
* Hooks exist for the more generic cases. With the 'edit' context, the * Hooks exist for the more generic cases. With the 'edit' context, the {@see 'edit_$field'}
* {@see 'edit_$field'} filter will be called and passed the `$value` and `$bookmark_id` * filter will be called and passed the `$value` and `$bookmark_id` respectively.
* 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 * With the 'db' context, the {@see 'pre_$field'} filter is called and passed the value.
* `$field` has the filter name and is passed the `$value`, `$bookmark_id`, and * The 'display' context is the final context and has the `$field` has the filter name
* `$context`, respectively. * and is passed the `$value`, `$bookmark_id`, and `$context`, respectively.
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param string $field The bookmark field * @param string $field The bookmark field.
* @param mixed $value The bookmark field value * @param mixed $value The bookmark field value.
* @param int $bookmark_id Bookmark ID * @param int $bookmark_id Bookmark ID.
* @param string $context How to filter the field value. Either 'raw', 'edit', * @param string $context How to filter the field value. Accepts 'raw', 'edit', 'attribute',
* 'attribute', 'js', 'db', or 'display' * 'js', 'db', or 'display'
* @return mixed The filtered value * @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 ) { switch ( $field ) {
case 'link_id' : // ints case 'link_id' : // ints
case 'link_rating' : case 'link_rating' :

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @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. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.