Index: wp-admin/includes/bookmark.php =================================================================== --- wp-admin/includes/bookmark.php (revision 8976) +++ wp-admin/includes/bookmark.php (working copy) @@ -1,9 +1,30 @@ link_url = clean_url( $_GET['linkurl']); @@ -40,6 +68,14 @@ return $link; } +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $link_id + * @return unknown + */ function wp_delete_link($link_id) { global $wpdb; @@ -56,6 +92,14 @@ return true; } +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $link_id + * @return unknown + */ function wp_get_link_cats($link_id = 0) { $cats = wp_get_object_terms($link_id, 'link_category', 'fields=ids'); @@ -63,10 +107,26 @@ return array_unique($cats); } +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $link_id + * @return unknown + */ function get_link_to_edit( $link_id ) { return get_bookmark( $link_id, OBJECT, 'edit' ); } +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $linkdata + * @return unknown + */ function wp_insert_link($linkdata, $wp_error = false) { global $wpdb, $current_user; @@ -154,6 +214,14 @@ return $link_id; } +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $link_id + * @param unknown_type $link_categories + */ function wp_set_link_cats($link_id = 0, $link_categories = array()) { // If $link_categories isn't already an array, make it one: if (!is_array($link_categories) || 0 == count($link_categories)) @@ -167,6 +235,14 @@ clean_bookmark_cache($link_id); } // wp_set_link_cats() +/** + * {@internal Missing Short Description}} + * + * @since unknown + * + * @param unknown_type $linkdata + * @return unknown + */ function wp_update_link($linkdata) { $link_id = (int) $linkdata['link_id']; @@ -189,4 +265,4 @@ return wp_insert_link($linkdata); } -?> \ No newline at end of file +?> Index: wp-admin/includes/image.php =================================================================== --- wp-admin/includes/image.php (revision 8976) +++ wp-admin/includes/image.php (working copy) @@ -221,7 +221,7 @@ } /** - * Get extended image metadata, exif or iptc as available + * Get extended image metadata, exif or iptc as available. * * @since unknown * Index: wp-admin/includes/theme.php =================================================================== --- wp-admin/includes/theme.php (revision 8976) +++ wp-admin/includes/theme.php (working copy) @@ -1,5 +1,18 @@ user_email; @@ -132,6 +180,15 @@ endif; if ( !function_exists('wp_upgrade') ) : +/** + * Run WordPress Upgrade functions. + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @return null + */ function wp_upgrade() { global $wp_current_db_version, $wp_db_version; @@ -141,7 +198,7 @@ if ( $wp_db_version == $wp_current_db_version ) return; - if(!is_blog_installed()) + if( ! is_blog_installed() ) return; wp_check_mysql_version(); @@ -152,7 +209,13 @@ } endif; -// Functions to be called in install and upgrade scripts +/** + * Functions to be called in install and upgrade scripts. + * + * {@internal Missing Long Description}} + * + * @since unknown + */ function upgrade_all() { global $wp_current_db_version, $wp_db_version, $wp_rewrite; $wp_current_db_version = __get_option('db_version'); @@ -220,6 +283,11 @@ update_option('db_version', $wp_db_version); } +/** + * Execute changes made in WordPress 1.0. + * + * @since 1.0.0 + */ function upgrade_100() { global $wpdb; @@ -242,7 +310,6 @@ } } - $wpdb->query("UPDATE $wpdb->options SET option_value = REPLACE(option_value, 'wp-links/links-images/', 'wp-images/links/') WHERE option_name LIKE 'links_rating_image%' AND option_value LIKE 'wp-links/links-images/%'"); @@ -272,6 +339,11 @@ endif; } +/** + * Execute changes made in WordPress 1.0.1. + * + * @since 1.0.1 + */ function upgrade_101() { global $wpdb; @@ -285,7 +357,11 @@ add_clean_index($wpdb->links , 'link_visible'); } - +/** + * Execute changes made in WordPress 1.2. + * + * @since 1.2.0 + */ function upgrade_110() { global $wpdb; @@ -305,7 +381,6 @@ } } - // Get the GMT offset, we'll use that later on $all_options = get_alloptions_110(); @@ -342,6 +417,11 @@ } +/** + * Execute changes made in WordPress 1.5. + * + * @since 1.5.0 + */ function upgrade_130() { global $wpdb; @@ -419,6 +499,11 @@ make_site_theme(); } +/** + * Execute changes made in WordPress 2.0. + * + * @since 2.0.0 + */ function upgrade_160() { global $wpdb, $wp_current_db_version; @@ -497,6 +582,11 @@ } } +/** + * Execute changes made in WordPress 2.1. + * + * @since 2.1.0 + */ function upgrade_210() { global $wpdb, $wp_current_db_version; @@ -536,6 +626,11 @@ } } +/** + * Execute changes made in WordPress 2.3. + * + * @since 2.3.0 + */ function upgrade_230() { global $wp_current_db_version, $wpdb; @@ -706,6 +801,11 @@ } } +/** + * Remove old options from the database. + * + * @since 2.3.0 + */ function upgrade_230_options_table() { global $wpdb; $old_options_fields = array( 'option_can_override', 'option_type', 'option_width', 'option_height', 'option_description', 'option_admin_level' ); @@ -715,6 +815,11 @@ $wpdb->show_errors(); } +/** + * Remove old categories, link2cat, and post2cat database tables. + * + * @since 2.3.0 + */ function upgrade_230_old_tables() { global $wpdb; $wpdb->query('DROP TABLE IF EXISTS ' . $wpdb->prefix . 'categories'); @@ -722,13 +827,22 @@ $wpdb->query('DROP TABLE IF EXISTS ' . $wpdb->prefix . 'post2cat'); } +/** + * Upgrade old slugs made in version 2.2. + * + * @since 2.2.0 + */ function upgrade_old_slugs() { // upgrade people who were using the Redirect Old Slugs plugin global $wpdb; $wpdb->query("UPDATE $wpdb->postmeta SET meta_key = '_wp_old_slug' WHERE meta_key = 'old_slug'"); } - +/** + * Execute changes made in WordPress 2.5.0. + * + * @since 2.5.0 + */ function upgrade_250() { global $wp_current_db_version; @@ -738,6 +852,11 @@ } +/** + * Execute changes made in WordPress 2.5.1. + * + * @since 2.5.1 + */ function upgrade_251() { global $wp_current_db_version; @@ -745,12 +864,22 @@ update_option('secret', wp_generate_password(64)); } +/** + * Execute changes made in WordPress 2.5.2. + * + * @since 2.5.2 + */ function upgrade_252() { global $wpdb; $wpdb->query("UPDATE $wpdb->users SET user_activation_key = ''"); } +/** + * Execute changes made in WordPress 2.6. + * + * @since 2.6.0 + */ function upgrade_260() { global $wp_current_db_version; @@ -763,6 +892,11 @@ } } +/** + * Execute changes made in WordPress 2.7. + * + * @since 2.7.0 + */ function upgrade_270() { global $wpdb, $wp_current_db_version; @@ -778,6 +912,18 @@ // The functions we use to actually do stuff // General + +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param string $table_name Database table name to create. + * @param string $create_ddl SQL statement to create table. + * @return bool If table already exists or was created by function. + */ function maybe_create_table($table_name, $create_ddl) { global $wpdb; foreach ($wpdb->get_col("SHOW TABLES",0) as $table ) { @@ -796,6 +942,17 @@ return false; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param string $table Database table name. + * @param string $index Index name to drop. + * @return bool True, when finished. + */ function drop_index($table, $index) { global $wpdb; $wpdb->hide_errors(); @@ -808,6 +965,17 @@ return true; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param string $table Database table name. + * @param string $index Database table index column. + * @return bool True, when done with execution. + */ function add_clean_index($table, $index) { global $wpdb; drop_index($table, $index); @@ -840,8 +1008,13 @@ return false; } - -// get_alloptions as it was for 1.2. +/** + * Retrieve all options as it was for 1.2. + * + * @since 1.2.0 + * + * @return array List of options. + */ function get_alloptions_110() { global $wpdb; if ($options = $wpdb->get_results("SELECT option_name, option_value FROM $wpdb->options")) { @@ -857,7 +1030,15 @@ return $all_options; } -// Version of get_option that is private to install/upgrade. +/** + * Version of get_option that is private to install/upgrade. + * + * @since unknown + * @access private + * + * @param string $setting Option name. + * @return mixed + */ function __get_option($setting) { global $wpdb; @@ -884,6 +1065,16 @@ return $option; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param string $content + * @return string + */ function deslash($content) { // Note: \\\ inside a regex denotes a single backslash. @@ -901,6 +1092,17 @@ return $content; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param unknown_type $queries + * @param unknown_type $execute + * @return unknown + */ function dbDelta($queries, $execute = true) { global $wpdb; @@ -1102,6 +1304,13 @@ return $for_update; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + */ function make_db_current() { global $wp_queries; @@ -1111,12 +1320,30 @@ echo "\n"; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + */ function make_db_current_silent() { global $wp_queries; $alterations = dbDelta($wp_queries); } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param unknown_type $theme_name + * @param unknown_type $template + * @return unknown + */ function make_site_theme_from_oldschool($theme_name, $template) { $home_path = get_home_path(); $site_dir = WP_CONTENT_DIR . "/themes/$template"; @@ -1185,6 +1412,17 @@ return true; } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param unknown_type $theme_name + * @param unknown_type $template + * @return unknown + */ function make_site_theme_from_default($theme_name, $template) { $site_dir = WP_CONTENT_DIR . "/themes/$template"; $default_dir = WP_CONTENT_DIR . '/themes/default'; @@ -1240,6 +1478,15 @@ } // Create a site theme from the default theme. +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @return unknown + */ function make_site_theme() { // Name the theme after the blog. $theme_name = __get_option('blogname'); @@ -1281,6 +1528,14 @@ return $template; } +/** + * Translate user level to user role name. + * + * @since unknown + * + * @param int $level User level. + * @return string User role name. + */ function translate_level_to_role($level) { switch ($level) { case 10: @@ -1302,6 +1557,13 @@ } } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + */ function wp_check_mysql_version() { global $wpdb; $result = $wpdb->check_database_version(); @@ -1309,6 +1571,13 @@ die( $result->get_error_message() ); } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + */ function maybe_disable_automattic_widgets() { $plugins = __get_option( 'active_plugins' ); Index: wp-admin/includes/user.php =================================================================== --- wp-admin/includes/user.php (revision 8976) +++ wp-admin/includes/user.php (working copy) @@ -1,6 +1,21 @@ prefix . 'user_level'; return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value != '0'", $level_key) ); } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param int $user_id User ID. + * @return array|bool List of editable authors. False if no editable users. + */ function get_editable_authors( $user_id ) { global $wpdb; @@ -163,6 +207,17 @@ return apply_filters('get_editable_authors', $authors); } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @param int $user_id User ID. + * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros. + * @return unknown + */ function get_editable_user_ids( $user_id, $exclude_zeros = true ) { global $wpdb; @@ -184,6 +239,15 @@ return $wpdb->get_col( $query ); } +/** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * + * @return unknown + */ function get_nonauthor_user_ids() { global $wpdb; $level_key = $wpdb->prefix . 'user_level'; @@ -191,6 +255,15 @@ return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value = '0'", $level_key) ); } +/** + * Retrieve editable posts from other users. + * + * @since unknown + * + * @param int $user_id User ID to not retrieve posts from. + * @param string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'. + * @return array List of posts from others. + */ function get_others_unpublished_posts($user_id, $type='any') { global $wpdb; @@ -213,14 +286,38 @@ return apply_filters('get_others_drafts', $other_unpubs); } +/** + * Retrieve drafts from other users. + * + * @since unknown + * + * @param int $user_id User ID. + * @return array List of drafts from other users. + */ function get_others_drafts($user_id) { return get_others_unpublished_posts($user_id, 'draft'); } +/** + * Retrieve pending review posts from other users. + * + * @since unknown + * + * @param int $user_id User ID. + * @return array List of posts with pending review post type from other users. + */ function get_others_pending($user_id) { return get_others_unpublished_posts($user_id, 'pending'); } +/** + * Retrieve user data and filter it. + * + * @since unknown + * + * @param int $user_id User ID. + * @return object WP_User object with user data. + */ function get_user_to_edit( $user_id ) { $user = new WP_User( $user_id ); $user->user_login = attribute_escape($user->user_login); @@ -238,6 +335,14 @@ return $user; } +/** + * Retrieve the user's drafts. + * + * @since unknown + * + * @param int $user_id User ID. + * @return array + */ function get_users_drafts( $user_id ) { global $wpdb; $query = $wpdb->prepare("SELECT ID, post_title FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'draft' AND post_author = %d ORDER BY post_modified DESC", $user_id); @@ -245,6 +350,20 @@ return $wpdb->get_results( $query ); } +/** + * Remove user and optionally reassign posts and links to another user. + * + * If the $reassign parameter is not assigned to an User ID, then all posts will + * be deleted of that user. The action 'delete_user' that is passed the User ID + * being deleted will be run after the posts are either reassigned or deleted. + * The user meta will also be deleted that are for that User ID. + * + * @since unknown + * + * @param int $id User ID. + * @param int $reassign Optional. Reassign posts and links to new User ID. + * @return bool True when finished. + */ function wp_delete_user($id, $reassign = 'novalue') { global $wpdb; @@ -279,6 +398,13 @@ return true; } +/** + * Remove all capabilities from user. + * + * @since unknown + * + * @param int $id User ID. + */ function wp_revoke_user($id) { $id = (int) $id; @@ -286,28 +412,161 @@ $user->remove_all_caps(); } -// WP_User_Search class -// by Mark Jaquith - if ( !class_exists('WP_User_Search') ) : +/** + * WordPress User Search class. + * + * @since unknown + * @author Mark Jaquith + */ class WP_User_Search { + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $results; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $search_term; + + /** + * Page number. + * + * @since unknown + * @access private + * @var int + */ var $page; + + /** + * Role name that users have. + * + * @since unknown + * @access private + * @var string + */ var $role; + + /** + * Raw page number. + * + * @since unknown + * @access private + * @var int|bool + */ var $raw_page; + + /** + * Amount of users to display per page. + * + * @since unknown + * @access public + * @var int + */ var $users_per_page = 50; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $first_user; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var int + */ var $last_user; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $query_limit; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $query_sort; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $query_from_where; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var int + */ var $total_users_for_query = 0; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var bool + */ var $too_many_total_users = false; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $search_errors; + + /** + * {@internal Missing Description}} + * + * @since unknown + * @access private + * @var unknown_type + */ var $paging_text; - function WP_User_Search ($search_term = '', $page = '', $role = '') { // constructor + /** + * PHP4 Constructor - Sets up the object properties. + * + * @since unknown + * + * @param string $search_term Search terms string. + * @param int $page Optional. Page ID. + * @param string $role Role name. + * @return WP_User_Search + */ + function WP_User_Search ($search_term = '', $page = '', $role = '') { $this->search_term = $search_term; $this->raw_page = ( '' == $page ) ? false : (int) $page; $this->page = (int) ( '' == $page ) ? 1 : $page; @@ -319,6 +578,14 @@ $this->do_paging(); } + /** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * @access public + */ function prepare_query() { global $wpdb; $this->first_user = ($this->page - 1) * $this->users_per_page; @@ -343,6 +610,14 @@ } + /** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * @access public + */ function query() { global $wpdb; $this->results = $wpdb->get_col('SELECT ID ' . $this->query_from_where . $this->query_sort . $this->query_limit); @@ -353,10 +628,26 @@ $this->search_errors = new WP_Error('no_matching_users_found', __('No matching users were found!')); } + /** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * @access public + */ function prepare_vars_for_template_usage() { $this->search_term = stripslashes($this->search_term); // done with DB, from now on we want slashes gone } + /** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * @access public + */ function do_paging() { if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results $args = array(); @@ -375,20 +666,56 @@ } } + /** + * {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since unknown + * @access public + * + * @return unknown + */ function get_results() { return (array) $this->results; } + /** + * Displaying paging text. + * + * @see do_paging() Builds paging text. + * + * @since unknown + * @access public + */ function page_links() { echo $this->paging_text; } + /** + * Whether paging is enabled. + * + * @see do_paging() Builds paging text. + * + * @since unknown + * @access public + * + * @return bool + */ function results_are_paged() { if ( $this->paging_text ) return true; return false; } + /** + * Whether there are search terms. + * + * @since unknown + * @access public + * + * @return bool + */ function is_search() { if ( $this->search_term ) return true; Index: wp-admin/includes/widgets.php =================================================================== --- wp-admin/includes/widgets.php (revision 8976) +++ wp-admin/includes/widgets.php (working copy) @@ -9,10 +9,12 @@ /** * Display list of widgets, either all or matching search. * + * The search parameter are search terms separated by spaces. + * * @since unknown * - * @param unknown_type $show - * @param unknown_type $_search Optional. Search for widgets. Should be unsanitized. + * @param string $show Optional, default is all. What to display, can be 'all', 'unused', or 'used'. + * @param string $_search Optional. Search for widgets. Should be unsanitized. */ function wp_list_widgets( $show = 'all', $_search = false ) { global $wp_registered_widgets, $sidebars_widgets, $wp_registered_widget_controls; @@ -168,7 +170,7 @@ * * @since unknown * - * @param unknown_type $sidebar + * @param string $sidebar */ function wp_list_widget_controls( $sidebar ) { add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' ); @@ -188,8 +190,8 @@ * * @since unknown * - * @param unknown_type $params - * @return unknown + * @param array $params + * @return array */ function wp_list_widget_controls_dynamic_sidebar( $params ) { global $wp_registered_widgets; @@ -216,8 +218,8 @@ * * @since unknown * - * @param unknown_type $sidebar_args - * @return unknown + * @param array $sidebar_args + * @return array */ function wp_widget_control( $sidebar_args ) { global $wp_registered_widgets, $wp_registered_widget_controls, $sidebars_widgets, $edit_widget; @@ -322,8 +324,8 @@ * * @since unknown * - * @param unknown_type $string - * @return unknown + * @param string $string + * @return string */ function wp_widget_control_ob_filter( $string ) { if ( false === $beg = strpos( $string, '%BEG_OF_TITLE%' ) )