[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-forums/bbpress/bb-includes/ -> functions.bb-meta.php (summary)

(no description)

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

Defines 34 functions

  bb_sanitize_meta_key()
  bb_update_meta()
  bb_delete_meta()
  bb_append_meta()
  _bb_append_meta_sort()
  bb_option()
  bb_get_option()
  bb_get_option_from_db()
  bb_form_option()
  bb_get_form_option()
  bb_cache_all_options()
  bb_update_option()
  bb_delete_option()
  bb_delete_transient()
  bb_get_transient()
  bb_set_transient()
  bb_get_usermeta()
  bb_update_usermeta()
  bb_delete_usermeta()
  bb_user_settings()
  bb_get_user_setting()
  bb_update_user_setting()
  bb_delete_user_setting()
  bb_get_all_user_settings()
  bb_delete_all_user_settings()
  bb_get_forummeta()
  bb_update_forummeta()
  bb_delete_forummeta()
  bb_get_topicmeta()
  bb_update_topicmeta()
  bb_delete_topicmeta()
  bb_get_postmeta()
  bb_update_postmeta()
  bb_delete_postmeta()

Functions
Functions that are not part of a class:

bb_sanitize_meta_key( $key )   X-Ref
No description

bb_update_meta( $object_id = 0, $meta_key, $meta_value, $type, $global = false )   X-Ref
Adds and updates meta data in the database


bb_delete_meta( $object_id = 0, $meta_key, $meta_value, $type, $global = false )   X-Ref
Deletes meta data from the database


bb_append_meta( $object, $type )   X-Ref
Adds an objects meta data to the object

This is the only function that should add to user / topic - NOT bbdb::prepared


_bb_append_meta_sort( $a, $b )   X-Ref
Sorts meta keys by length to ensure $appended_object->{$bbdb->prefix} key overwrites $appended_object->key as desired


bb_option( $option )   X-Ref
Echoes the requested bbPress option by calling bb_get_option()

param: string The option to be echoed
return: void

bb_get_option( $option )   X-Ref
Returns the requested bbPress option from the meta table or the $bb object

param: string The option to be echoed
return: mixed The value of the option

bb_get_option_from_db( $option )   X-Ref
Retrieves and returns the requested bbPress option from the meta table

param: string The option to be echoed
return: void

bb_form_option( $option )   X-Ref
No description

bb_get_form_option( $option )   X-Ref
No description

bb_cache_all_options()   X-Ref
No description

bb_update_option( $option, $value )   X-Ref
No description

bb_delete_option( $option, $value = '' )   X-Ref
No description

bb_delete_transient( $transient )   X-Ref
Delete a transient

param: string $transient Transient name. Expected to not be SQL-escaped
return: bool true if successful, false otherwise
since: 1.0

bb_get_transient( $transient )   X-Ref
Get the value of a transient

If the transient does not exist or does not have a value, then the return value
will be false.

param: string $transient Transient name. Expected to not be SQL-escaped
return: mixed Value of transient
since: 1.0

bb_set_transient( $transient, $value, $expiration = 0 )   X-Ref
Set/update the value of a transient

You do not need to serialize values, if the value needs to be serialize, then
it will be serialized before it is set.

param: string $transient Transient name. Expected to not be SQL-escaped
param: mixed $value Transient value.
param: int $expiration Time until expiration in seconds, default 0
return: bool False if value was not set and true if value was set.
since: 1.0

bb_get_usermeta( $user_id, $meta_key )   X-Ref
No description

bb_update_usermeta( $user_id, $meta_key, $meta_value )   X-Ref
No description

bb_delete_usermeta( $user_id, $meta_key, $meta_value = null )   X-Ref
No description

bb_user_settings()   X-Ref
Saves and restores user interface settings stored in a cookie.

Checks if the current user-settings cookie is updated and stores it. When no
cookie exists (different browser used), adds the last saved cookie restoring
the settings.

since: 1.0

bb_get_user_setting( $name, $default = false )   X-Ref
Retrieve user interface setting value based on setting name.

param: string $name The name of the setting.
param: string $default Optional default value to return when $name is not set.
return: mixed the last saved user setting or the default value/false if it doesn't exist.
since: 1.0

bb_update_user_setting( $name, $value )   X-Ref
Adds or updates a user interface setting value based on setting name.

param: string $name The name of the setting.
param: string $value The value of the setting.
since: 1.0

bb_delete_user_setting( $names )   X-Ref
Delete user interface settings.

Deleting settings would reset them to the defaults.

param: mixed $names The name or array of names of the setting to be deleted.
since: 1.0

bb_get_all_user_settings()   X-Ref
Retrieve all user interface settings.

return: array the last saved user settings or empty array.
since: 1.0

bb_delete_all_user_settings()   X-Ref
Delete the user settings of the current user.

since: 1.0

bb_get_forummeta( $forum_id, $meta_key )   X-Ref
No description

bb_update_forummeta( $forum_id, $meta_key, $meta_value )   X-Ref
No description

bb_delete_forummeta( $forum_id, $meta_key, $meta_value = '' )   X-Ref
No description

bb_get_topicmeta( $topic_id, $meta_key )   X-Ref
No description

bb_update_topicmeta( $topic_id, $meta_key, $meta_value )   X-Ref
No description

bb_delete_topicmeta( $topic_id, $meta_key, $meta_value = '' )   X-Ref
No description

bb_get_postmeta( $post_id, $meta_key )   X-Ref
No description

bb_update_postmeta( $post_id, $meta_key, $meta_value )   X-Ref
No description

bb_delete_postmeta( $post_id, $meta_key, $meta_value = '' )   X-Ref
No description



Generated: Thu Dec 7 01:01:35 2017 Cross-referenced by PHPXref 0.7.1