groups_get_groupmeta( int $group_id, string $meta_key = '', bool $single = true )

Get a piece of group metadata.

Description

Parameters

$group_id

(int) (Required) ID of the group.

$meta_key

(string) (Optional) Metadata key.

Default value: ''

$single

(bool) (Optional) If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is empty.

Default value: true

Return

(mixed) Metadata value.

Source

File: bp-groups/bp-groups-functions.php

function groups_get_groupmeta( $group_id, $meta_key = '', $single = true ) {
	add_filter( 'query', 'bp_filter_metaid_column_name' );
	$retval = get_metadata( 'group', $group_id, $meta_key, $single );
	remove_filter( 'query', 'bp_filter_metaid_column_name' );

	return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Used By
Used By	Description
bp-templates/bp-nouveau/includes/messages/ajax.php: bp_nouveau_ajax_delete_thread()	AJAX delete entire thread.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_groups_send_message()	Send group message to group members.
bp-messages/bp-messages-filters.php: bp_messages_add_user_to_group_message_thread()	Remove member to Group thread when h/she joined the group.
bp-messages/bp-messages-filters.php: bp_messages_remove_user_to_group_message_thread()	Add member to Group thread when h/she joined the group.
bp-messages/bp-messages-filters.php: bp_group_messages_groups_membership_accepted()	Add new message to a existing group thread when someone membership is accepted in group.
bp-messages/bp-messages-filters.php: bp_group_messages_join_new_member()	Add new message to a existing group thread when someone join in group.
bp-messages/bp-messages-filters.php: bp_group_messages_remove_group_member_from_thread()	Add new message to a existing group thread when someone remove from group.
bp-messages/bp-messages-filters.php: bp_group_messages_accept_new_member()	Add new message to group thread if new member joined the group.
bp-messages/bp-messages-filters.php: bp_group_messages_banned_member()	Add new message to group thread when someone from the group ban.
bp-messages/bp-messages-filters.php: bp_group_messages_admin_banned_member()	Add new message to group thread when someone from the group ban.
bp-messages/bp-messages-filters.php: bp_group_messages_unbanned_member()	Add new message to group thread when someone from the group unban.
bp-messages/classes/class-bp-rest-group-messages-endpoint.php: BP_REST_Group_Messages_Endpoint::create_item()	Init a Messages Thread or add a reply to an existing Thread.
bp-groups/bp-groups-template.php: bp_group_get_message_status()	Get the message status of a group.
bp-groups/bp-groups-template.php: bp_group_get_document_status()	Get the media status of a group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_response()	Prepares group data for return as an object.
bp-forums/groups.php: BBP_Forums_Group_Extension::create_screen()	Show forums and new forum form when creating a group
bp-forums/groups.php: BBP_Forums_Group_Extension::maybe_unset_forum_menu()	Maybe unset the group forum nav item if group does not have a forum
bp-forums/functions.php: bbp_get_group_forum_ids()	Get forum ID’s for a group
bp-messages/classes/class-bp-messages-thread.php: BP_Messages_Thread::delete()	Mark messages in a thread as deleted or delete all messages in a thread.
bp-groups/classes/class-bp-groups-list-table.php: BP_Groups_List_Table::column_members()	Markup for the Number of Members column.
bp-groups/classes/class-bp-groups-list-table.php: BP_Groups_List_Table::column_last_active()	Markup for the Last Active column.
bp-groups/classes/class-bp-groups-group.php: BP_Groups_Group::__get()	Magic getter.
bp-groups/bp-groups-activity.php: bp_groups_format_activity_action_group_details_updated()	Format ‘group_details_updated’ activity actions.
bp-groups/bp-groups-template.php: bp_group_get_media_status()	Get the media status of a group.
bp-groups/bp-groups-template.php: bp_group_get_invite_status()	Get the invite status of a group.
bp-groups/bp-groups-template.php: bp_group_get_activity_feed_status()	Get the activity feed status of a group.
bp-groups/bp-groups-template.php: bp_group_get_album_status()	Get the album status of a group.
bp-groups/bp-groups-template.php: bp_get_group_last_active()	Return the ‘last active’ string for the current group in the loop.
bp-integrations/learndash/library/SyncGenerator.php: SyncGenerator::loadLdGroupId()	Find the ld group id on current bp group
bp-integrations/learndash/library/SyncGenerator.php: SyncGenerator::fullSyncToLearndash()	Run a full users sync up bp group to ld group
bp-integrations/learndash/library/SyncGenerator.php: SyncGenerator::fullSyncToBuddypress()	Run a full users sync up ld group to bp group
bp-core/bp-core-filters.php: bp_dd_update_group_cover_images_url()	Filter to update group cover images
bp-core/bp-core-filters.php: bp_dd_check_avatar_folder_dir()	Create dummy path for Group and User
bp-core/bp-core-filters.php: bp_dd_fetch_dummy_avatar_url()	Get dummy URL from DB for Group and User

Show 29 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents