| [ Index ] |
PHP Cross Reference of Wordpress 2.9.1 |
[Source view] [Print] [Project Stats]
WordPress user administration API.
| File Size: | 831 lines (23 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_User_Search:: (12 methods):
WP_User_Search()
prepare_query()
query()
prepare_vars_for_template_usage()
do_paging()
get_results()
page_links()
results_are_paged()
is_search()
default_password_nag_handler()
default_password_nag_edit_user()
default_password_nag()
Class: WP_User_Search - X-Ref
WordPress User Search class.| WP_User_Search($search_term = '', $page = '', $role = '') X-Ref |
| PHP4 Constructor - Sets up the object properties. param: string $search_term Search terms string. param: int $page Optional. Page ID. param: string $role Role name. return: WP_User_Search |
| prepare_query() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} |
| query() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} |
| prepare_vars_for_template_usage() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} |
| do_paging() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} |
| get_results() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} return: unknown |
| page_links() X-Ref |
| Displaying paging text. |
| results_are_paged() X-Ref |
| Whether paging is enabled. return: bool |
| is_search() X-Ref |
| Whether there are search terms. return: bool |
| default_password_nag_handler($errors = false) X-Ref |
| No description |
| default_password_nag_edit_user($user_ID, $old_data) X-Ref |
| No description |
| default_password_nag() X-Ref |
| No description |
| add_user() X-Ref |
| Creates a new user from the "Users" form using $_POST information. It seems that the first half is for backwards compatibility, but only has the ability to alter the user's role. WordPress core seems to use this function only in the second way, running edit_user() with no id so as to create a new user. param: int $user_id Optional. User ID. return: null|WP_Error|int Null when adding user, WP_Error or User ID integer when no parameters. |
| edit_user( $user_id = 0 ) X-Ref |
| Edit user settings based on contents of $_POST Used on user-edit.php and profile.php to manage and process user options, passwords etc. param: int $user_id Optional. User ID. return: int user id of the updated user |
| get_author_user_ids() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} return: array List of user IDs. |
| get_editable_authors( $user_id ) X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} param: int $user_id User ID. return: array|bool List of editable authors. False if no editable users. |
| get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} param: int $user_id User ID. param: bool $exclude_zeros Optional, default is true. Whether to exclude zeros. return: unknown |
| get_editable_roles() X-Ref |
| Fetch a filtered list of user roles that the current user is allowed to edit. Simple function who's main purpose is to allow filtering of the list of roles in the $wp_roles object so that plugins can remove innappropriate ones depending on the situation or user making edits. Specifically because without filtering anyone with the edit_users capability can edit others to be administrators, even if they are only editors or authors. This filter allows admins to delegate user management. return: unknown |
| get_nonauthor_user_ids() X-Ref |
| {@internal Missing Short Description}} {@internal Missing Long Description}} return: unknown |
| get_others_unpublished_posts($user_id, $type='any') X-Ref |
| Retrieve editable posts from other users. 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. |
| get_others_drafts($user_id) X-Ref |
| Retrieve drafts from other users. param: int $user_id User ID. return: array List of drafts from other users. |
| get_others_pending($user_id) X-Ref |
| Retrieve pending review posts from other users. param: int $user_id User ID. return: array List of posts with pending review post type from other users. |
| get_user_to_edit( $user_id ) X-Ref |
| Retrieve user data and filter it. param: int $user_id User ID. return: object WP_User object with user data. |
| get_users_drafts( $user_id ) X-Ref |
| Retrieve the user's drafts. param: int $user_id User ID. return: array |
| wp_delete_user($id, $reassign = 'novalue') X-Ref |
| 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. param: int $id User ID. param: int $reassign Optional. Reassign posts and links to new User ID. return: bool True when finished. |
| wp_revoke_user($id) X-Ref |
| Remove all capabilities from user. param: int $id User ID. |
| Generated: Fri Jan 8 00:19:48 2010 | Cross-referenced by PHPXref 0.7 |