Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
BBP_User_Engagements_User::get_user_option_key( string $meta_key = '', int $object_id, bool $prefix = false )
Private function to map 2.6 meta keys to 2.5 user-option keys.
Description Description
Parameters Parameters
- $meta_key
-
(Optional)
Default value: ''
- $object_id
-
(Required)
- $prefix
-
(Optional)
Default value: false
Return Return
(string)
Source Source
File: includes/common/engagements.php
private function get_user_option_key( $meta_key = '', $object_id = 0, $prefix = false ) {
switch ( $meta_key ) {
// Favorites
case '_bbp_favorite' :
$key = '_bbp_favorites';
break;
// Subscriptions
case '_bbp_subscription' :
// Maybe guess at post type
$post_type = ! empty( $object_id )
? get_post_type( $object_id )
: bbp_get_topic_post_type();
// Forums & Topics used different keys :/
$key = ( bbp_get_forum_post_type() === $post_type )
? '_bbp_forum_subscriptions'
: '_bbp_subscriptions';
break;
// Unknown, so pluralize
default :
$key = "{$meta_key}s";
break;
}
// Maybe prefix the key (for use in raw database queries)
if ( true === $prefix ) {
$key = bbp_db()->get_blog_prefix() . $key;
}
// Return the old (pluralized) user option key
return $key;
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |