/bbp-includes/bbp-user-options.php

Description

bbPress User Options

Functions
bbp_add_user_options (line 41)

Add default user options

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

  • since: bbPress (r3910)
  • uses: update_user_option() - Adds default options
  • uses: bbp_get_default_user_options() - To get default options
  • uses: do_action() - Calls 'bbp_add_user_options'
void bbp_add_user_options ([ $user_id = 0])
  • $user_id
bbp_delete_user_options (line 67)

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: bbPress (r3910)
  • uses: do_action() - Calls 'bbp_delete_options'
  • uses: bbp_get_default_user_options() - To get default options
  • uses: delete_user_option() - Removes default options
void bbp_delete_user_options ([ $user_id = 0])
  • $user_id
bbp_filter_get_user_option (line 109)

Filter default options and allow them to be overloaded from inside the $bbp->user_options array.

  • return: false if not overloaded, mixed if set
  • since: bbPress (r3910)
mixed bbp_filter_get_user_option ([bool $value = false], [ $option = ''], [ $user = 0])
  • bool $value: Optional. Default value false
  • $option
  • $user
bbp_get_default_user_options (line 19)

Get the default user options and their values

array bbp_get_default_user_options ()
bbp_get_user_last_posted (line 271)

Return the raw value of teh last posted time.

mixed bbp_get_user_last_posted ([int $user_id = 0])
  • int $user_id: User ID to retrieve value for
bbp_get_user_post_count (line 215)

Return a users total post count

string bbp_get_user_post_count ([int $user_id = 0])
  • int $user_id
bbp_get_user_reply_count (line 180)

Return a users reply count

string bbp_get_user_reply_count ([int $user_id = 0])
  • int $user_id
bbp_get_user_topic_count (line 145)

Return a users reply count

string bbp_get_user_topic_count ([int $user_id = 0])
  • int $user_id
bbp_setup_user_option_filters (line 91)

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

  • since: bbPress (r3910)
  • uses: do_action() - Calls 'bbp_add_option_filters'
  • uses: add_filter() - To add filters to 'pre_option_{$key}'
  • uses: bbp_get_default_user_options() - To get default options
void bbp_setup_user_option_filters ()
bbp_update_user_last_posted (line 239)

Update a users last posted time, for use with post throttling

  • return: False if no user or failure, true if successful
  • since: bbPress (r3910)
  • usedby: bbp_update_reply() - To update the users last posted time
  • usedby: bbp_update_topic() - To update the users last posted time
bool bbp_update_user_last_posted ([int $user_id = 0], [int $time = 0])
  • int $user_id: User ID to update
  • int $time: Time in time() format
bbp_user_last_posted (line 260)

Output the raw value of the last posted time.

void bbp_user_last_posted ([int $user_id = 0])
  • int $user_id: User ID to retrieve value for
bbp_user_post_count (line 201)

Output a users total post count

string bbp_user_post_count ([int $user_id = 0])
  • int $user_id
bbp_user_reply_count (line 166)

Output a users reply count

string bbp_user_reply_count ([int $user_id = 0])
  • int $user_id
bbp_user_topic_count (line 131)

Output a users topic count

string bbp_user_topic_count ([int $user_id = 0])
  • int $user_id

Documentation generated on Sat, 01 Nov 2014 01:48:32 +0000 by phpDocumentor 1.4.3