[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/users/ -> template.php (summary)

bbPress User Template Tags

File Size: 2395 lines (65 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BBP_User_Query:: (85 methods):
  __construct()
  next_user()
  the_user()
  have_users()
  rewind_users()
  bbp_has_users()
  bbp_users()
  bbp_the_user()
  bbp_user_id()
  bbp_get_user_id()
  bbp_current_user_id()
  bbp_get_current_user_id()
  bbp_displayed_user_id()
  bbp_get_displayed_user_id()
  bbp_displayed_user_field()
  bbp_get_displayed_user_field()
  bbp_current_user_name()
  bbp_get_current_user_name()
  bbp_current_user_avatar()
  bbp_get_current_user_avatar()
  bbp_user_profile_link()
  bbp_get_user_profile_link()
  bbp_user_nicename()
  bbp_get_user_nicename()
  bbp_user_profile_url()
  bbp_get_user_profile_url()
  bbp_user_profile_edit_link()
  bbp_get_user_profile_edit_link()
  bbp_user_profile_edit_url()
  bbp_get_user_profile_edit_url()
  bbp_user_display_role()
  bbp_get_user_display_role()
  bbp_admin_link()
  bbp_get_admin_link()
  bbp_author_ip()
  bbp_get_author_ip()
  bbp_get_fallback_display_name()
  bbp_author_display_name()
  bbp_get_author_display_name()
  bbp_author_email()
  bbp_get_author_email()
  bbp_author_url()
  bbp_get_author_url()
  bbp_favorites_permalink()
  bbp_get_favorites_permalink()
  bbp_user_favorites_link()
  bbp_get_user_favorites_link()
  bbp_subscriptions_permalink()
  bbp_get_subscriptions_permalink()
  bbp_user_subscribe_link()
  bbp_get_user_subscribe_link()
  bbp_notice_edit_user_success()
  bbp_notice_edit_user_pending_email()
  bbp_notice_edit_user_is_super_admin()
  bbp_edit_user_display_name()
  bbp_edit_user_blog_role()
  bbp_edit_user_forums_role()
  bbp_edit_user_contact_methods()
  bbp_edit_user_language()
  bbp_user_topics_created_url()
  bbp_get_user_topics_created_url()
  bbp_user_replies_created_url()
  bbp_get_user_replies_created_url()
  bbp_user_engagements_url()
  bbp_get_user_engagements_url()
  bbp_user_languages_dropdown()
  bbp_get_user_languages_dropdown()
  bbp_login_notices()
  bbp_logged_in_redirect()
  bbp_user_login_fields()
  bbp_user_register_fields()
  bbp_user_lost_pass_fields()
  bbp_author_link()
  bbp_get_author_link()
  bbp_user_can_view_forum()
  bbp_current_user_can_publish_topics()
  bbp_current_user_can_publish_forums()
  bbp_current_user_can_publish_replies()
  bbp_get_forums_for_current_user()
  bbp_current_user_can_access_create_forum_form()
  bbp_current_user_can_access_create_topic_form()
  bbp_current_user_can_access_create_reply_form()
  bbp_current_user_can_access_anonymous_user_form()
  bbp_moderator_list()
  bbp_get_moderator_list()


Class: BBP_User_Query  - X-Ref

Extension of WP_User_Query to allow easy looping

__construct( $query = null )   X-Ref
PHP5 constructor.

param: null|string|array $query Optional. The query variables.
since: 2.6.0 bbPress (r6330)

next_user()   X-Ref
Set up the next user and iterate current user index.

return: WP_User Next user.
since: 2.6.0 bbPress (r6330)

the_user()   X-Ref
Sets up the current user.

Retrieves the next user, sets up the user, sets the 'in the loop'
property to true.

since: 2.6.0 bbPress (r6330)

have_users()   X-Ref
Determines whether there are more users available in the loop.

Calls the {@see 'loop_end'} action when the loop is complete.

return: bool True if users are available, false if end of loop.
since: 2.6.0 bbPress (r6330)

rewind_users()   X-Ref
Rewind the users and reset user index.

since: 2.6.0 bbPress (r6330)

bbp_has_users( $args = array()   X-Ref
The main user loop.

return: object Multidimensional array of user information
param: array $args All the arguments supported by {@link WP_User_Query}
since: 2.6.0 bbPress (r6330)

bbp_users()   X-Ref
Whether there are more users available in the loop

return: object User information
since: 2.6.0 bbPress (r2464)

bbp_the_user()   X-Ref
Loads up the current user in the loop

return: object User information
since: 2.6.0 bbPress (r2464)

bbp_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false )   X-Ref
Output a validated user id

param: int $user_id Optional. User id
param: bool $displayed_user_fallback Fallback on displayed user?
param: bool $current_user_fallback Fallback on current user?
since: 2.0.0 bbPress (r2729)

bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false )   X-Ref
Return a validated user id

return: int Validated user id
param: int $user_id Optional. User id
param: bool $displayed_user_fallback Fallback on displayed user?
param: bool $current_user_fallback Fallback on current user?
since: 2.0.0 bbPress (r2729)

bbp_current_user_id()   X-Ref
Output ID of current user

since: 2.0.0 bbPress (r2574)

bbp_get_current_user_id()   X-Ref
Return ID of current user

return: int Current user id
since: 2.0.0 bbPress (r2574)

bbp_displayed_user_id()   X-Ref
Output ID of displayed user

since: 2.0.0 bbPress (r2688)

bbp_get_displayed_user_id()   X-Ref
Return ID of displayed user

return: int Displayed user id
since: 2.0.0 bbPress (r2688)

bbp_displayed_user_field( $field = '', $filter = 'display' )   X-Ref
Output a sanitized user field value

This function relies on the $filter parameter to decide how to sanitize
the field value that it finds. Since it uses the WP_User object's magic
__get() method, it can also be used to get user_meta values.

param: string $field Field to get
param: string $filter How to filter the field value (null|raw|db|display|edit)
since: 2.0.0 bbPress (r2688)

bbp_get_displayed_user_field( $field = '', $filter = 'display' )   X-Ref
Return a sanitized user field value

This function relies on the $filter parameter to decide how to sanitize
the field value that it finds. Since it uses the WP_User object's magic
__get() method, it can also be used to get user_meta values.

return: string|bool Value of the field if it exists, else false
param: string $field Field to get
param: string $filter How to filter the field value (null|raw|db|display|edit)
since: 2.0.0 bbPress (r2688)

bbp_current_user_name()   X-Ref
Output name of current user

since: 2.0.0 bbPress (r2574)

bbp_get_current_user_name()   X-Ref
Return name of current user

return: string
since: 2.0.0 bbPress (r2574)

bbp_current_user_avatar( $size = 40 )   X-Ref
Output avatar of current user

param: int $size Size of the avatar. Defaults to 40
since: 2.0.0 bbPress (r2574)

bbp_get_current_user_avatar( $size = 40 )   X-Ref
Return avatar of current user

return: string Current user avatar
param: int $size Size of the avatar. Defaults to 40
since: 2.0.0 bbPress (r2574)

bbp_user_profile_link( $user_id = 0 )   X-Ref
Output link to the profile page of a user

param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)

bbp_get_user_profile_link( $user_id = 0 )   X-Ref
Return link to the profile page of a user

return: string User profile link
param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)

bbp_user_nicename( $user_id = 0, $args = array()   X-Ref
Output a users nicename to the screen

param: int $user_id User ID whose nicename to get
param: array $args before|after|user_id|force
since: 2.3.0 bbPress (r4671)

bbp_get_user_nicename( $user_id = 0, $args = array()   X-Ref
Return a users nicename to the screen

return: string User nicename, maybe wrapped in before/after strings
param: int $user_id User ID whose nicename to get
param: array $args before|after|user_id|force
since: 2.3.0 bbPress (r4671)

bbp_user_profile_url( $user_id = 0, $user_nicename = '' )   X-Ref
Output URL to the profile page of a user

param: int $user_id Optional. User id
param: string $user_nicename Optional. User nicename
since: 2.0.0 bbPress (r2688)

bbp_get_user_profile_url( $user_id = 0, $user_nicename = '' )   X-Ref
Return URL to the profile page of a user

return: string User profile url
param: int $user_id Optional. User id
param: string $user_nicename Optional. User nicename
since: 2.0.0 bbPress (r2688)

bbp_user_profile_edit_link( $user_id = 0 )   X-Ref
Output link to the profile edit page of a user

param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)

bbp_get_user_profile_edit_link( $user_id = 0 )   X-Ref
Return link to the profile edit page of a user

return: string User profile edit link
param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)

bbp_user_profile_edit_url( $user_id = 0, $user_nicename = '' )   X-Ref
Output URL to the profile edit page of a user

param: int $user_id Optional. User id
param: string $user_nicename Optional. User nicename
since: 2.0.0 bbPress (r2688)

bbp_get_user_profile_edit_url( $user_id = 0, $user_nicename = '' )   X-Ref
Return URL to the profile edit page of a user

return: string
param: int $user_id Optional. User id
param: string $user_nicename Optional. User nicename
since: 2.0.0 bbPress (r2688)

bbp_user_display_role( $user_id = 0 )   X-Ref
Output a user's main role for display

param: int $user_id
since: 2.1.0 bbPress (r3860)

bbp_get_user_display_role( $user_id = 0 )   X-Ref
Return a user's main role for display

return: string
param: int $user_id
since: 2.1.0 bbPress (r3860)

bbp_admin_link( $args = array()   X-Ref
Output the link to the admin section

param: array $args Optional. See {@link bbp_get_admin_link()}
since: 2.0.0 bbPress (r2827)

bbp_get_admin_link( $args = array()   X-Ref
Return the link to the admin section

return: The link
param: array $args Optional. This function supports these arguments:
since: 2.0.0 bbPress (r2827)

bbp_author_ip( $args = array()   X-Ref
Output the author IP address of a post

param: array $args Optional. If it is an integer, it is used as post id.
since: 2.0.0 bbPress (r3120)

bbp_get_author_ip( $args = array()   X-Ref
Return the author IP address of a post

return: string Author link of reply
param: array $args Optional. If an integer, it is used as reply id.
since: 2.0.0 bbPress (r3120)

bbp_get_fallback_display_name( $object_id = 0 )   X-Ref
Get the default name that's displayed when a user cannot be identified.

This might happen if a user was deleted but their content was retained, or
if something went wrong during saving anonymous user data to the database.

return: string
param: int $object_id For additional context only, usually a post ID
since: 2.6.0 bbPress (r6561)

bbp_author_display_name( $post_id = 0 )   X-Ref
Output the author display-name of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous form template-part.

param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_get_author_display_name( $post_id = 0 )   X-Ref
Return the author display-name of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous form template-part.

return: string The name of the author
param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_author_email( $post_id = 0 )   X-Ref
Output the author email of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous user form template-part.

param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_get_author_email( $post_id = 0 )   X-Ref
Return the author email of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous user form template-part.

return: string The email of the author
param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_author_url( $post_id = 0 )   X-Ref
Output the author url of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous user form template-part.

param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_get_author_url( $post_id = 0 )   X-Ref
Return the author url of a topic or reply.

Convenience function to ensure proper template functions are called
and correct filters are executed. Used primarily to display topic
and reply author information in the anonymous user form template-part.

return: string The url of the author
param: int $post_id
since: 2.5.0 bbPress (r5119)

bbp_favorites_permalink( $user_id = 0 )   X-Ref
Output the link to the user's favorites page (profile page)

param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2652)
since: 2.6.0 bbPress (r6308) Add pagination if in the loop

bbp_get_favorites_permalink( $user_id = 0 )   X-Ref
Return the link to the user's favorites page (profile page)

return: string Permanent link to user profile page
param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2652)
since: 2.6.0 bbPress (r6308) Add pagination if in the loop

bbp_user_favorites_link( $args = array()   X-Ref
Output the link to make a topic favorite/remove a topic from favorites

param: array $args See {@link bbp_get_user_favorites_link()}
param: int $user_id Optional. User id
param: bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">.
since: 2.0.0 bbPress (r2652)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_get_user_favorites_link( $args = array()   X-Ref
User favorites link

Return the link to make a topic favorite/remove a topic from
favorites

return: string User favorites link
param: array $args This function supports these arguments:
param: int $user_id Optional. User id
param: int $topic_id Optional. Topic id
param: bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">. See ajax_favorite()
since: 2.0.0 bbPress (r2652)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_subscriptions_permalink( $user_id = 0 )   X-Ref
Output the link to the user's subscriptions page (profile page)

param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)
since: 2.6.0 bbPress (r6308) Add pagination if in the loop

bbp_get_subscriptions_permalink( $user_id = 0 )   X-Ref
Return the link to the user's subscriptions page (profile page)

return: string Permanent link to user subscriptions page
param: int $user_id Optional. User id
since: 2.0.0 bbPress (r2688)
since: 2.6.0 bbPress (r6308) Add pagination if in the loop

bbp_user_subscribe_link( $args = array()   X-Ref
Output the link to subscribe/unsubscribe from a topic

param: array $args See {@link bbp_get_user_subscribe_link()}
param: int $user_id Optional. User id
param: bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
since: 2.0.0 bbPress (r2668)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_get_user_subscribe_link( $args = array()   X-Ref
Return the link to subscribe/unsubscribe from a forum or topic

return: string Permanent link to topic
param: array $args This function supports these arguments:
param: int $user_id Optional. User id
param: bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
since: 2.0.0 bbPress (r2668)
since: 2.6.0 bbPress (r6308) Add 'redirect_to' support

bbp_notice_edit_user_success()   X-Ref
Display profile edit success notice on user edit page

since: 2.0.0 bbPress (r2688)

bbp_notice_edit_user_pending_email()   X-Ref
Display pending email change notice on user edit page

since: 2.6.0 bbPress (r5660)

bbp_notice_edit_user_is_super_admin()   X-Ref
Super admin privileges notice

since: 2.0.0 bbPress (r2688)

bbp_edit_user_display_name()   X-Ref
Drop down for selecting the user's display name

since: 2.0.0 bbPress (r2688)

bbp_edit_user_blog_role()   X-Ref
Output blog role selector (for user edit)

since: 2.0.0 bbPress (r2688)

bbp_edit_user_forums_role()   X-Ref
Output forum role selector (for user edit)

since: 2.2.0 bbPress (r4284)

bbp_edit_user_contact_methods()   X-Ref
Return user contact methods select box

return: string User contact methods
since: 2.0.0 bbPress (r2688)

bbp_edit_user_language( $args = array()   X-Ref
Output the language chooser (for user edit)

return: string
param: array $args See wp_dropdown_languages()
since: 2.6.0 bbPress (r6488)

bbp_user_topics_created_url( $user_id = 0 )   X-Ref
Output the link to the user's topics

param: int $user_id Optional. User id
since: 2.2.0 bbPress (r4225)

bbp_get_user_topics_created_url( $user_id = 0 )   X-Ref
Return the link to the user's topics

return: string Permanent link to user profile page
param: int $user_id Optional. User id
since: 2.2.0 bbPress (r4225)

bbp_user_replies_created_url( $user_id = 0 )   X-Ref
Output the link to the user's replies

param: int $user_id Optional. User id
since: 2.2.0 bbPress (r4225)

bbp_get_user_replies_created_url( $user_id = 0 )   X-Ref
Return the link to the user's replies

return: string Permanent link to user profile page
param: int $user_id Optional. User id
since: 2.2.0 bbPress (r4225)

bbp_user_engagements_url( $user_id = 0 )   X-Ref
Output the link to the user's engagements

param: int $user_id Optional. User id
since: 2.6.0 bbPress (r6320)

bbp_get_user_engagements_url( $user_id = 0 )   X-Ref
Return the link to the user's engagements

return: string Permanent link to user profile page
param: int $user_id Optional. User id
since: 2.6.0 bbPress (r6320)

bbp_user_languages_dropdown( $args = array()   X-Ref
Output the select element used to save a user's language

param: array $args See wp_dropdown_languages()
since: 2.6.0 bbPress (r6488)

bbp_get_user_languages_dropdown( $args = array()   X-Ref
Return the select element used to save a user's language.

return: string
param: array $args See wp_dropdown_languages()
since: 2.6.0 bbPress (r6488)

bbp_login_notices()   X-Ref
Handle the login and registration template notices

since: 2.0.0 bbPress (r2970)

bbp_logged_in_redirect( $url = '' )   X-Ref
Redirect a user back to their profile if they are already logged in.

This should be used before {@link get_header()} is called in template files
where the user should never have access to the contents of that file.

param: string $url The URL to redirect to
since: 2.0.0 bbPress (r2815)

bbp_user_login_fields()   X-Ref
Output the required hidden fields when logging in

since: 2.0.0 bbPress (r2815)

bbp_user_register_fields()   X-Ref
Output the required hidden fields when registering

since: 2.0.0 bbPress (r2815)

bbp_user_lost_pass_fields()   X-Ref
Output the required hidden fields when user lost password

since: 2.0.0 bbPress (r2815)

bbp_author_link( $args = array()   X-Ref
Output the author link of a post

param: array $args Optional. If it is an integer, it is used as post id.
since: 2.0.0 bbPress (r2875)

bbp_get_author_link( $args = array()   X-Ref
Return the author link of the post

return: string Author link of reply
param: array $args Optional. If an integer, it is used as reply id.
since: 2.0.0 bbPress (r2875)

bbp_user_can_view_forum( $args = array()   X-Ref
Check if the user can access a specific forum

return: bool
since: 2.0.0 bbPress (r3127)

bbp_current_user_can_publish_topics()   X-Ref
Check if the current user can publish topics

return: bool
since: 2.0.0 bbPress (r3127)

bbp_current_user_can_publish_forums()   X-Ref
Check if the current user can publish forums

return: bool
since: 2.1.0 bbPress (r3549)

bbp_current_user_can_publish_replies()   X-Ref
Check if the current user can publish replies

return: bool
since: 2.0.0 bbPress (r3127)

bbp_get_forums_for_current_user( $args = array()   X-Ref
Get the forums the current user has the ability to see and post to

return: array
param: array $args
since: 2.0.0 bbPress (r3127)

bbp_current_user_can_access_create_forum_form()   X-Ref
Performs a series of checks to ensure the current user can create forums.

return: bool
since: 2.1.0 bbPress (r3549)

bbp_current_user_can_access_create_topic_form()   X-Ref
Performs a series of checks to ensure the current user can create topics.

return: bool
since: 2.0.0 bbPress (r3127)

bbp_current_user_can_access_create_reply_form()   X-Ref
Performs a series of checks to ensure the current user can create replies.

return: bool
since: 2.0.0 bbPress (r3127)

bbp_current_user_can_access_anonymous_user_form()   X-Ref
Performs a series of checks to ensure the current user should see the
anonymous user form fields.

return: bool
since: 2.5.0 bbPress (r5119)

bbp_moderator_list( $forum_id = 0, $args = array()   X-Ref
Output the moderators of a forum

param: int   $forum_id Optional. Topic id
param: array $args     See {@link bbp_get_moderator_list()}
since: 2.6.0 bbPress

bbp_get_moderator_list( $object_id = 0, $args = array()   X-Ref
Return the moderators for an object

return: string Moderator list of the object
param: int   $object_id Optional. Object id
param: array $args     This function supports these arguments:
since: 2.6.0 bbPress



Generated: Wed Jul 24 01:01:31 2019 Cross-referenced by PHPXref 0.7.1