WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/25/2008 03:45:05 PM (14 years ago)
Author:
ryan
Message:

phpdoc updates from jacobsantos. see #7038

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/bookmark.php

    r7193 r7990  
    88
    99/**
    10  * get_bookmark() - Get Bookmark data based on ID
     10 * Retrieve Bookmark data based on ID
    1111 *
    1212 * @since 2.1
     
    3838
    3939/**
    40  * get_bookmark_field() - Gets single bookmark data item or field.
     40 * Retrieve single bookmark data item or field.
    4141 *
    4242 * @since 2.3
     
    6666
    6767/**
    68  * get_link() - Returns bookmark data based on ID.
     68 * Retrieve bookmark data based on ID.
    6969 *
    7070 * @since 2.0
     
    8181
    8282/**
    83  * get_bookmarks() - Retrieves the list of bookmarks
     83 * Retrieves the list of bookmarks
    8484 *
    8585 * Attempts to retrieve from the cache first based on MD5 hash of arguments. If
     
    8888 *
    8989 * List of default arguments are as follows:
    90  * 'orderby' - Default is 'name' (string). How to order the links by. String is based off of the bookmark scheme.
    91  * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either ascending or descending order.
    92  * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to display.
    93  * 'category' - Default is empty string (string). Include the links in what category ID(s).
    94  * 'category_name' - Default is empty string (string). Get links by category name.
    95  * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide links marked as 'invisible'.
    96  * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated.
    97  * 'include' - Default is empty string (string). Include other categories separated by commas.
    98  * 'exclude' - Default is empty string (string). Exclude other categories separated by commas.
     90 * 'orderby' - Default is 'name' (string). How to order the links by. String is
     91 *      based off of the bookmark scheme.
     92 * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
     93 *      ascending or descending order.
     94 * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
     95 *      display.
     96 * 'category' - Default is empty string (string). Include the links in what
     97 *      category ID(s).
     98 * 'category_name' - Default is empty string (string). Get links by category
     99 *      name.
     100 * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
     101 *      links marked as 'invisible'.
     102 * 'show_updated' - Default is 0 (integer). Will show the time of when the
     103 *      bookmark was last updated.
     104 * 'include' - Default is empty string (string). Include other categories
     105 *      separated by commas.
     106 * 'exclude' - Default is empty string (string). Exclude other categories
     107 *      separated by commas.
    99108 *
    100109 * @since 2.1
    101110 * @uses $wpdb Database Object
     111 * @link http://codex.wordpress.org/Template_Tags/get_bookmarks
    102112 *
    103113 * @param string|array $args List of arguments to overwrite the defaults
     
    227237
    228238/**
    229  * sanitize_bookmark() - Sanitizes all bookmark fields
     239 * Sanitizes all bookmark fields
    230240 *
    231241 * @since 2.3
    232242 *
    233243 * @param object|array $bookmark Bookmark row
    234  * @param string $context Optional, default is 'display'. How to filter the fields
     244 * @param string $context Optional, default is 'display'. How to filter the
     245 *      fields
    235246 * @return object|array Same type as $bookmark but with fields sanitized.
    236247 */
     
    255266
    256267/**
    257  * sanitize_bookmark_field() - Sanitizes a bookmark field
    258  *
    259  * Sanitizes the bookmark fields based on what the field name is. If the field has a
    260  * strict value set, then it will be tested for that, else a more generic filtering is
    261  * applied. After the more strict filter is applied, if the $context is 'raw' then the
    262  * value is immediately return.
    263  *
    264  * Hooks exist for the more generic cases. With the 'edit' context, the 'edit_$field'
    265  * filter will be called and passed the $value and $bookmark_id respectively. With the
    266  * 'db' context, the 'pre_$field' filter is called and passed the value. The 'display'
    267  * context is the final context and has the $field has the filter name and is passed the
    268  * $value, $bookmark_id, and $context respectively.
     268 * Sanitizes a bookmark field
     269 *
     270 * Sanitizes the bookmark fields based on what the field name is. If the field
     271 * has a strict value set, then it will be tested for that, else a more generic
     272 * filtering is applied. After the more strict filter is applied, if the
     273 * $context is 'raw' then the value is immediately return.
     274 *
     275 * Hooks exist for the more generic cases. With the 'edit' context, the
     276 * 'edit_$field' filter will be called and passed the $value and $bookmark_id
     277 * respectively. With the 'db' context, the 'pre_$field' filter is called and
     278 * passed the value. The 'display' context is the final context and has the
     279 * $field has the filter name and is passed the $value, $bookmark_id, and
     280 * $context respectively.
    269281 *
    270282 * @since 2.3
     
    273285 * @param mixed $value The bookmark field value
    274286 * @param int $bookmark_id Bookmark ID
    275  * @param string $context How to filter the field value. Either 'raw', 'edit', 'attribute', 'js', 'db', or 'display'
     287 * @param string $context How to filter the field value. Either 'raw', 'edit',
     288 *      'attribute', 'js', 'db', or 'display'
    276289 * @return mixed The filtered value
    277290 */
     
    319332
    320333/**
    321  * delete_get_bookmark_cache() - Deletes entire bookmark cache
     334 * Deletes entire bookmark cache
    322335 *
    323336 * @since 2.1
Note: See TracChangeset for help on using the changeset viewer.