Index: widgets.php =================================================================== --- widgets.php (revision 8947) +++ widgets.php (working copy) @@ -377,7 +377,7 @@ * @since 2.2.0 * @see wp_unregister_widget_control() * - * @param int $id Widget ID + * @param int $id Widget ID. */ function unregister_widget_control($id) { return wp_unregister_widget_control($id); @@ -637,10 +637,8 @@ /* Default Widgets */ /** - * {@internal Missing Short Description}} + * Display pages widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param array $args Widget arguments. @@ -672,10 +670,8 @@ } /** - * {@internal Missing Short Description}} + * Display and process pages widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_pages_control() { @@ -720,10 +716,8 @@ } /** - * {@internal Missing Short Description}} + * Display links widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param array $args Widget arguments. @@ -740,10 +734,8 @@ } /** - * {@internal Missing Short Description}} + * Display search widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param array $args Widget arguments. @@ -769,10 +761,8 @@ } /** - * {@internal Missing Short Description}} + * Display archives widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param array $args Widget arguments. @@ -803,10 +793,8 @@ } /** - * {@internal Missing Short Description}} + * Display and process archives widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_archives_control() { @@ -835,13 +823,13 @@ } /** - * {@internal Missing Short Description}} + * Display meta widget. * - * {@internal Missing Long Description}} + * Displays log in/out, RSS feed links, etc. * * @since 2.2.0 * - * @param array $args Widget Arguments + * @param array $args Widget arguments. */ function wp_widget_meta($args) { extract($args); @@ -863,10 +851,8 @@ } /** - * {@internal Missing Short Description}} + * Display and process meta widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_meta_control() { @@ -886,10 +872,8 @@ } /** - * {@internal Missing Short Description}} + * Display calendar widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param array $args Widget arguments. @@ -908,10 +892,8 @@ } /** - * {@internal Missing Short Description}} + * Display and process calendar widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_calendar_control() { @@ -965,10 +947,8 @@ } /** - * {@internal Missing Short Description}} + * Display and process text widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * * @param int $widget_args Widget number. @@ -1036,10 +1016,8 @@ } /** - * {@internal Missing Short Description}} + * Register text widget on startup. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_text_register() { @@ -1067,16 +1045,15 @@ } /** - * {@internal Missing Short Description}} + * Display categories widget. * - * {@internal Missing Long Description}} + * Allows multiple category widgets. * * @since 2.2.0 * - * @param unknown_type $args - * @param unknown_type $number + * @param array $args Widget arguments. + * @param int $number Widget number. */ -// See large comment section at end of this file function wp_widget_categories($args, $widget_args = 1) { extract($args, EXTR_SKIP); if ( is_numeric($widget_args) ) @@ -1132,13 +1109,11 @@ } /** - * {@internal Missing Short Description}} + * Display and process categories widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * - * @param unknown_type $number + * @param int $widget_args Widget number. */ function wp_widget_categories_control( $widget_args ) { global $wp_registered_widgets; @@ -1227,10 +1202,8 @@ } /** - * {@internal Missing Short Description}} + * Register categories widget on startup. * - * {@internal Missing Long Description}} - * * @since 2.3.0 */ function wp_widget_categories_register() { @@ -1262,13 +1235,11 @@ } /** - * {@internal Missing Short Description}} + * Upgrade previous category widget to current version. * - * {@internal Missing Long Description}} - * * @since 2.3.0 * - * @return unknown + * @return array */ function wp_widget_categories_upgrade() { $options = get_option( 'widget_categories' ); @@ -1298,14 +1269,12 @@ } /** - * {@internal Missing Short Description}} + * Display recent entries widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * - * @param unknown_type $args - * @return unknown + * @param array $args Widget arguments. + * @return int Displayed cache. */ function wp_widget_recent_entries($args) { if ( '%BEG_OF_TITLE%' != $args['before_title'] ) { @@ -1346,8 +1315,6 @@ /** * Remove recent entries widget items cache. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_flush_widget_recent_entries() { @@ -1359,10 +1326,8 @@ add_action('switch_theme', 'wp_flush_widget_recent_entries'); /** - * {@internal Missing Short Description}} + * Display and process recent entries widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_recent_entries_control() { @@ -1392,13 +1357,11 @@ } /** - * {@internal Missing Short Description}} + * Display recent comments widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * - * @param unknown_type $args + * @param array $args Widget arguments. */ function wp_widget_recent_comments($args) { global $wpdb, $comments, $comment; @@ -1431,8 +1394,6 @@ /** * Remove the cache for recent comments widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_delete_recent_comments_cache() { @@ -1442,10 +1403,8 @@ add_action( 'wp_set_comment_status', 'wp_delete_recent_comments_cache' ); /** - * {@internal Missing Short Description}} + * Display and process recent comments widget options form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_recent_comments_control() { @@ -1476,8 +1435,6 @@ /** * Display the style for recent comments widget. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_recent_comments_style() { @@ -1487,10 +1444,8 @@ } /** - * {@internal Missing Short Description}} + * Register recent comments with control and hook for 'wp_head' action. * - * {@internal Missing Long Description}} - * * @since 2.2.0 */ function wp_widget_recent_comments_register() { @@ -1503,16 +1458,15 @@ } /** - * {@internal Missing Short Description}} + * Display RSS widget. * - * {@internal Missing Long Description}} + * Allows for multiple widgets to be displayed. * * @since 2.2.0 * - * @param unknown_type $args - * @param unknown_type $number + * @param array $args Widget arguments. + * @param int $number Widget number. */ -// See large comment section at end of this file function wp_widget_rss($args, $widget_args = 1) { extract($args, EXTR_SKIP); if ( is_numeric($widget_args) ) @@ -1564,6 +1518,14 @@ echo $after_widget; } +/** + * Display the RSS entries in a list. + * + * @since 2.5.0 + * + * @param string|array|object $rss RSS url. + * @param array $args Widget arguments. + */ function wp_widget_rss_output( $rss, $args = array() ) { if ( is_string( $rss ) ) { require_once(ABSPATH . WPINC . '/rss.php'); @@ -1648,13 +1610,11 @@ } /** - * wp_widget_rss_control() - {@internal Missing Short Description}} + * Display and process RSS widget control form. * - * {@internal Missing Long Description}} - * * @since 2.2.0 * - * @param unknown_type $widget_args + * @param int $widget_args Widget number. */ function wp_widget_rss_control($widget_args) { global $wp_registered_widgets; @@ -1726,7 +1686,7 @@ * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author', * 'show_date'. * - * @since unknown + * @since 2.5.0 * * @param array|string $args Values for input fields. * @param array $inputs Override default display options. @@ -1813,7 +1773,7 @@ * feed items, error (if any), and whether to show summary, author, and date. * All respectively in the order of the array elements. * - * @since unknown + * @since 2.5.0 * * @param array $widget_rss RSS widget feed data. Expects unescaped data. * @param bool $check_feed Optional, default is true. Whether to check feed for errors. @@ -1848,7 +1808,7 @@ } /** - * Register RSS widget to allow multiple RSS widgets. + * Register RSS widget to allow multiple RSS widgets on startup. * * @since 2.2.0 */ @@ -1923,7 +1883,7 @@ } /** - * Register all of the default WordPress widgets. + * Register all of the default WordPress widgets on startup. * * Calls 'widgets_init' action after all of the WordPress widgets have been * registered. @@ -1974,11 +1934,19 @@ add_action('init', 'wp_widgets_init', 1); -/* Pattern for multi-widget (allows multiple instances such as the text widget). +/* + * Pattern for multi-widget (allows multiple instances such as the text widget). + * + * Make sure to close the comments after copying. -// Displays widget on blag -// $widget_args: number -// number: which of the several widgets of this type do we mean +/** + * Displays widget. + * + * Supports multiple widgets. + * + * @param array $args Widget arguments. + * @param array|int $widget_args Widget number. Which of the several widgets of this type do we mean. + * / function widget_many( $args, $widget_args = 1 ) { extract( $args, EXTR_SKIP ); if ( is_numeric($widget_args) ) @@ -1998,9 +1966,13 @@ echo $after_widget; } -// Displays form for a particular instance of the widget. Also updates the data after a POST submit -// $widget_args: number -// number: which of the several widgets of this type do we mean +/** + * Displays form for a particular instance of the widget. + * + * Also updates the data after a POST submit. + * + * @param array|int $widget_args Widget number. Which of the several widgets of this type do we mean. + * / function widget_many_control( $widget_args = 1 ) { global $wp_registered_widgets; static $updated = false; // Whether or not we have already updated the data after a POST submit @@ -2068,7 +2040,9 @@