Changeset 7990 for trunk/wp-includes/bookmark.php

Timestamp:

05/25/2008 03:45:05 PM (16 years ago)

Author:

ryan

Message:

phpdoc updates from jacobsantos. see #7038

File:

• trunk/wp-includes/bookmark.php (modified) (9 diffs)

trunk/wp-includes/bookmark.php

@@ -8 +8 @@
 
 /**
- * get_bookmark() - Get Bookmark data based on ID
+ * Retrieve Bookmark data based on ID
  *
  * @since 2.1
@@ -38 +38 @@
 
 /**
- * get_bookmark_field() - Gets single bookmark data item or field.
+ * Retrieve single bookmark data item or field.
  *
  * @since 2.3
@@ -66 +66 @@
 
 /**
- * get_link() - Returns bookmark data based on ID.
+ * Retrieve bookmark data based on ID.
  *
  * @since 2.0
@@ -81 +81 @@
 
 /**
- * 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
@@ -88 +88 @@
  *
  * 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
@@ -227 +237 @@
 
 /**
- * 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.
  */
@@ -255 +266 @@
 
 /**
- * sanitize_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.
- *
- * 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.
+ * 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.
+ *
+ * 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
@@ -273 +285 @@
  * @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
  */
@@ -319 +332 @@
 
 /**
- * delete_get_bookmark_cache() - Deletes entire bookmark cache
+ * Deletes entire bookmark cache
  *
  * @since 2.1