| [ Index ] |
PHP Cross Reference of BBPress |
[Source view] [Print] [Project Stats]
bbPress User Functions
| File Size: | 1012 lines (29 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bbp_redirect_login( $url = '', $raw_url = '', $user = '' ) X-Ref |
| Redirect back to $url when attempting to use the login page param: string $url The url param: string $raw_url Raw url param: object $user User object since: 2.0.0 bbPress (r2815) |
| bbp_is_anonymous() X-Ref |
| Is an anonymous topic/reply being made? return: bool True if anonymous is allowed and user is not logged in, false if since: 2.0.0 bbPress (r2688) |
| bbp_current_anonymous_user_data( $key = '' ) X-Ref |
| Echoes the values for current poster (uses WP comment cookies) param: string $key Which value to echo? since: 2.0.0 bbPress (r2734) |
| bbp_get_current_anonymous_user_data( $key = '' ) X-Ref |
| Get the cookies for current poster (uses WP comment cookies). return: string|array Cookie(s) for current poster param: string $key Optional. Which value to get? If not given, then since: 2.0.0 bbPress (r2734) |
| bbp_set_current_anonymous_user_data( $anonymous_data = array() X-Ref |
| Set the cookies for current poster (uses WP comment cookies) param: array $anonymous_data Optional - if it's an anonymous post. Do not since: 2.0.0 bbPress (r2734) |
| bbp_current_author_ip() X-Ref |
| Get the poster IP address return: string since: 2.0.0 bbPress (r3120) since: 2.6.0 bbPress (r5609) Added `empty()` check for unit tests |
| bbp_current_author_ua() X-Ref |
| Get the poster user agent return: string since: 2.0.0 bbPress (r3446) |
| bbp_edit_user_handler( $action = '' ) X-Ref |
| Handles the front end user editing from POST requests param: string $action The requested action to compare this function to since: 2.0.0 bbPress (r2790) |
| bbp_user_email_change_handler( $action = '' ) X-Ref |
| Handles user email address updating from GET requests param: string $action since: 2.6.0 bbPress (r5660) |
| bbp_edit_user_email_send_notification( $user_id = 0, $args = array() X-Ref |
| Sends an email when an email address change occurs on POST requests since: 2.6.0 bbPress (r5660) |
| bbp_user_edit_after() X-Ref |
| Conditionally hook the core WordPress output actions to the end of the default user's edit profile template This allows clever plugin authors to conditionally unhook the WordPress core output actions if they don't want any unexpected junk to appear there, and also avoids needing to pollute the templates with additional logic and actions. since: 2.2.0 bbPress (r4273) |
| bbp_get_user_topics_started( $args = array() X-Ref |
| Get the topics that a user created return: bool True if user has started topics, otherwise false param: array $args Optional. Arguments to pass into bbp_has_topics() since: 2.0.0 bbPress (r2660) since: 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments |
| bbp_get_user_replies_created( $args = array() X-Ref |
| Get the replies that a user created return: bool True if user has created replies, otherwise false param: array $args Optional. Arguments to pass into bbp_has_replies() since: 2.2.0 bbPress (r4225) since: 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments |
| bbp_get_user_ids_from_nicenames( $user_nicenames = array() X-Ref |
| Get user IDs from nicenames This function is primarily used when saving object moderators return: array param: mixed $user_nicenames since: 2.6.0 bbPress |
| bbp_get_user_nicenames_from_ids( $user_ids = array() X-Ref |
| Get user nicenames from IDs This function is primarily used when saving object moderators return: array param: mixed $user_ids since: 2.6.0 bbPress |
| bbp_get_user_topic_count_raw( $user_id = 0 ) X-Ref |
| Return the raw database count of topics by a user return: int Raw DB count of topics param: int $user_id User ID to get count for since: 2.1.0 bbPress (r3633) |
| bbp_get_user_reply_count_raw( $user_id = 0 ) X-Ref |
| Return the raw database count of replies by a user return: int Raw DB count of replies param: int $user_id User ID to get count for since: 2.1.0 bbPress (r3633) |
| bbp_bump_user_topic_count( $user_id = 0, $difference = 1 ) X-Ref |
| Bump the topic count for a user by a certain amount. param: int $user_id param: int $difference since: 2.6.0 bbPress (r5309) |
| bbp_bump_user_reply_count( $user_id = 0, $difference = 1 ) X-Ref |
| Bump the reply count for a user by a certain amount. param: int $user_id param: int $difference since: 2.6.0 bbPress (r5309) |
| bbp_increase_user_topic_count( $topic_id = 0 ) X-Ref |
| Helper function used to increase (by one) the count of topics for a user when a topic is published. param: $topic_id param: $forum_id param: $anonymous_data param: $topic_author since: 2.6.0 bbPress (r5309) |
| bbp_increase_user_reply_count( $reply_id = 0 ) X-Ref |
| Helper function used to increase (by one) the count of replies for a user when a reply is published. This is a helper function, hooked to `bbp_new_reply` param: $topic_id param: $forum_id param: $anonymous_data param: $topic_author since: 2.6.0 bbPress (r5309) |
| bbp_decrease_user_topic_count( $topic_id = 0 ) X-Ref |
| Helper function used to decrease (by one) the count of topics for a user when a topic is unpublished. param: $topic_id since: 2.6.0 bbPress (r5309) |
| bbp_decrease_user_reply_count( $reply_id = 0 ) X-Ref |
| Helper function used to increase (by one) the count of replies for a user when a topic is unpublished. param: $reply_id since: 2.6.0 bbPress (r5309) |
| bbp_check_user_edit() X-Ref |
| Redirect if unauthorized user is attempting to edit another user This is hooked to 'bbp_template_redirect' and controls the conditions under which a user can edit another user (or themselves.) If these conditions are met, we assume a user cannot perform this task, and look for ways they can earn the ability to access this template. since: 2.1.0 bbPress (r3605) |
| bbp_forum_enforce_blocked() X-Ref |
| Check if a user is blocked, or cannot spectate the forums. since: 2.0.0 bbPress (r2996) |
| bbp_sanitize_displayed_user_field( $value = '', $field = '', $context = 'display' ) X-Ref |
| Sanitize displayed user data, when viewing and editing any user. This somewhat monolithic function handles the escaping and sanitization of user data for a bbPress profile. There are two reasons this all happens here: 1. bbPress took a similar approach to WordPress, and funnels all user profile data through a central helper. This eventually calls sanitize_user_field() which applies a few context based filters, which some third party plugins might be relying on bbPress to play nicely with. 2. Early versions of bbPress 2.x templates did not escape this data meaning a backwards compatible approach like this one was necessary to protect existing installations that may have custom template parts. return: string param: string $value param: string $field param: string $context since: 2.6.0 bbPress (r5368) |
| bbp_user_maybe_convert_pass() X-Ref |
| Convert passwords from previous platform encryption to WordPress encryption. since: 2.1.0 bbPress (r3813) since: 2.6.10 bbPress (r7244) Switched from direct query to get_user_by() |
| Generated: Sat May 18 01:00:57 2024 | Cross-referenced by PHPXref 0.7.1 |