[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

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

bbPress User Options

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

Defines 16 functions

  bbp_get_default_user_options()
  bbp_add_user_options()
  bbp_delete_user_options()
  bbp_setup_user_option_filters()
  bbp_filter_get_user_option()
  bbp_update_user_topic_count()
  bbp_update_user_reply_count()
  bbp_user_topic_count()
  bbp_get_user_topic_count()
  bbp_user_reply_count()
  bbp_get_user_reply_count()
  bbp_user_post_count()
  bbp_get_user_post_count()
  bbp_update_user_last_posted()
  bbp_user_last_posted()
  bbp_get_user_last_posted()

Functions
Functions that are not part of a class:

bbp_get_default_user_options()   X-Ref
Get the default user options and their values

return: array Filtered user option names and values
since: 2.1.0 bbPress (r3910)

bbp_add_user_options( $user_id = 0 )   X-Ref
Add default user options

This is destructive, so existing bbPress user options will be overridden.

since: 2.1.0 bbPress (r3910)

bbp_delete_user_options( $user_id = 0 )   X-Ref
Delete default user options

Hooked to bbp_uninstall, it is only called once when bbPress is uninstalled.
This is destructive, so existing bbPress user options will be destroyed.

since: 2.1.0 bbPress (r3910)

bbp_setup_user_option_filters()   X-Ref
Add filters to each bbPress option and allow them to be overloaded from
inside the $bbp->options array.

since: 2.1.0 bbPress (r3910)

bbp_filter_get_user_option( $value = false, $option = '', $user = 0 )   X-Ref
Filter default options and allow them to be overloaded from inside the
$bbp->user_options array.

param: bool $value Optional. Default value false
return: mixed false if not overloaded, mixed if set
since: 2.1.0 bbPress (r3910)

bbp_update_user_topic_count( $user_id = 0, $count = false )   X-Ref
Update the topic count for a user

param: int $user_id
param: mixed $count
return: boolean
since: 2.6.0 bbPress (r5309)

bbp_update_user_reply_count( $user_id = 0, $count = false )   X-Ref
Update the reply count for a user

param: int $user_id
param: mixed $count
return: boolean
since: 2.6.0 bbPress (r5309)

bbp_user_topic_count( $user_id = 0, $integer = false )   X-Ref
Output a users topic count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_get_user_topic_count( $user_id = 0, $integer = false )   X-Ref
Return a users reply count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_user_reply_count( $user_id = 0, $integer = false )   X-Ref
Output a users reply count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_get_user_reply_count( $user_id = 0, $integer = false )   X-Ref
Return a users reply count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_user_post_count( $user_id = 0, $integer = false )   X-Ref
Output a users total post count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_get_user_post_count( $user_id = 0, $integer = false )   X-Ref
Return a users total post count

param: int $user_id
param: boolean $integer Optional. Whether or not to format the result
return: string
since: 2.1.0 bbPress (r3632)

bbp_update_user_last_posted( $user_id = 0, $time = 0 )   X-Ref
Update a users last posted time, for use with post throttling

param: int $user_id User ID to update
param: int $time Time in time() format
return: bool False if no user or failure, true if successful
since: 2.1.0 bbPress (r3910)

bbp_user_last_posted( $user_id = 0 )   X-Ref
Output the raw value of the last posted time.

param: int $user_id User ID to retrieve value for
since: 2.1.0 bbPress (r3910)

bbp_get_user_last_posted( $user_id = 0 )   X-Ref
Return the raw value of the last posted time.

param: int $user_id User ID to retrieve value for
return: mixed False if no user, time() format if exists
since: 2.1.0 bbPress (r3910)



Generated: Fri Oct 18 01:01:25 2019 Cross-referenced by PHPXref 0.7.1