vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

phpdoc updates from jacobsantos. see #7038

Browse Source 
git-svn-id: https://develop.svn.wordpress.org/trunk@7990 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Ryan Boren
2008-05-25 15:45:05 +00:00
parent 44084888b7
commit be87986f7a
5 changed files with 255 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wp-includes/bookmark.php
+40 -27
View File
@@ -7,7 +7,7 @@
*/
/**
* get_bookmark() - Get Bookmark data based on ID
* Retrieve Bookmark data based on ID
*
* @since 2.1
* @uses $wpdb Database Object
@@ -37,7 +37,7 @@ function get_bookmark($bookmark_id, $output = OBJECT, $filter = 'raw') {
}
/**
* get_bookmark_field() - Gets single bookmark data item or field.
* Retrieve single bookmark data item or field.
*
* @since 2.3
* @uses get_bookmark() Gets bookmark object using $bookmark as ID
@@ -65,7 +65,7 @@ function get_bookmark_field( $field, $bookmark, $context = 'display' ) {
}
/**
* get_link() - Returns bookmark data based on ID.
* Retrieve bookmark data based on ID.
*
* @since 2.0
* @deprecated Use get_bookmark()
@@ -80,25 +80,35 @@ function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
}
/**
* get_bookmarks() - Retrieves the list of bookmarks
* Retrieves the list of bookmarks
*
* Attempts to retrieve from the cache first based on MD5 hash of arguments. If
* that fails, then the query will be built from the arguments and executed. The
* results will be stored to the cache.
*
* List of default arguments are as follows:
* 'orderby' - Default is 'name' (string). How to order the links by. String is based off of the bookmark scheme.
* 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either ascending or descending order.
* 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to display.
* 'category' - Default is empty string (string). Include the links in what category ID(s).
* 'category_name' - Default is empty string (string). Get links by category name.
* 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide links marked as 'invisible'.
* 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated.
* 'include' - Default is empty string (string). Include other categories separated by commas.
* 'exclude' - Default is empty string (string). Exclude other categories separated by commas.
* 'orderby' - Default is 'name' (string). How to order the links by. String is
* based off of the bookmark scheme.
* 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
* ascending or descending order.
* 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
* display.
* 'category' - Default is empty string (string). Include the links in what
* category ID(s).
* 'category_name' - Default is empty string (string). Get links by category
* name.
* 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
* links marked as 'invisible'.
* 'show_updated' - Default is 0 (integer). Will show the time of when the
* bookmark was last updated.
* 'include' - Default is empty string (string). Include other categories
* separated by commas.
* 'exclude' - Default is empty string (string). Exclude other categories
* separated by commas.
*
* @since 2.1
* @uses $wpdb Database Object
* @link http://codex.wordpress.org/Template_Tags/get_bookmarks
*
* @param string|array $args List of arguments to overwrite the defaults
* @return array List of bookmark row objects
@@ -226,12 +236,13 @@ function get_bookmarks($args = '') {
}
/**
* sanitize_bookmark() - Sanitizes all bookmark fields
* Sanitizes all bookmark fields
*
* @since 2.3
*
* @param object|array $bookmark Bookmark row
* @param string $context Optional, default is 'display'. How to filter the fields
* @param string $context Optional, default is 'display'. How to filter the
* fields
* @return object|array Same type as $bookmark but with fields sanitized.
*/
function sanitize_bookmark($bookmark, $context = 'display') {
@@ -254,25 +265,27 @@ function sanitize_bookmark($bookmark, $context = 'display') {
}
/**
* sanitize_bookmark_field() - Sanitizes a bookmark field
* Sanitizes a bookmark 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 filtering is
* applied. After the more strict filter is applied, if the $context is 'raw' then the
* value is immediately return.
* 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.
*
* Hooks exist for the more generic cases. With the 'edit' context, the 'edit_$field'
* filter will be called and passed the $value and $bookmark_id respectively. With the
* 'db' context, the '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
* 'edit_$field' filter will be called and passed the $value and $bookmark_id
* respectively. With the 'db' context, the '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
*
* @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'
* @param string $context How to filter the field value. Either 'raw', 'edit',
* 'attribute', 'js', 'db', or 'display'
* @return mixed The filtered value
*/
function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
@@ -318,7 +331,7 @@ function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
}
/**
* delete_get_bookmark_cache() - Deletes entire bookmark cache
* Deletes entire bookmark cache
*
* @since 2.1
* @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'