Meta tags:
description=;
keywords=wordpress buddypress bbpress community support forums;

Headings (most frequently used words):

buddypress, codex, group, extension, api, overview, use, configuration, methods, examples, updated, recommendations, for, contents, article, contributors, want, to, help,

Text of the page (most frequently used words):
the (135), extension (41), for (35), your (35), #buddypress (32), you (32), group (31), function (22), defaults (22), admin (21), this (19), create (18), methods (17), that (17), tab (17), groups (16), name (16), value (16), will (16), and (16), edit (15), see (14), group_id (14), setting (14), which (11), bp_group_extension (11), plugin (11), optional (11), org (10), array (10), screens (10), display (10), developer (9), want (9), class (9), slug (9), used (9), described (9), api (8), note (8), when (8), options (8), screen (8), navigation (8), mod (8), step (8), true (8), not (7), codex (7), can (7), more (7), text (7), null (7), group_extension_example_2_setting (7), php (7), method (7), what (7), content (7), should (7), automatically (7), below (7), change (7), above (7), examples (6), use (6), bp_is_active (6), echo (6), settings_screen (6), creation (6), are (6), otherwise (6), member (6), call (6), attempts (6), determine (6), unless (6), know (6), doing (6), general (6), support (5), about (5), new (5), configuration (5), recommended (5), config (5), __construct (5), example (5), parent (5), init (5), group_extension_example_1_setting (5), has (5), possible (5), values (5), anyone (5), string (5), blog (4), documentation (4), wordpress (4), component (4), active (4), check (4), during (4), here (4), args (4), save (4), settings_screen_save (4), _post (4), them (4), settings (4), after (4), public (4), moderators (4), added (4), access (4), appears (4), using (4), have (4), false (4), enabled (4), arguments (4), log (3), register (3), trac (3), feedback (3), forums (3), bbpress (3), means (3), please (3), updated (3), problems (3), extensions (3), extends (3), customization (3), submit (3), page (3), position (3), 100 (3), groups_get_groupmeta (3), input (3), type (3), esc_attr (3), create_screen (3), context (3), following (3), bp_register_group_extension (3), pass (3), contains (3), markup (3), catch (3), all (3), dashboard (3), panels (3), very (3), these (3), flexible (3), user (3), current (3), private (3), only (3), available (3), subtab (3), metabox (3), been (3), saved (3), screen_save_callback (3), screen_callback (3), url (3), with (3), section (3), anonymous (2), skip (2), follow (2), also (2), creating (2), read (2), ago (2), years (2), recommendations (2), overview (2), before (2), prevent (2), upgrade (2), disabled (2), group_extension_example_2 (2), nav_item_position (2), changes (2), button (2), submit_text (2), bp_get_group_id (2), isset (2), groups_update_groupmeta (2), via (2), create_screen_save (2), edit_screen (2), edit_screen_save (2), admin_screen (2), admin_screen_save (2), endif (2), group_extension_example_1 (2), contain (2), main (2), logic (2), from (2), two (2), fully (2), functional (2), any (2), requires (2), called (2), submitted (2), necessary (2), three (2), allows (2), work (2), most (2), into (2), template (2), number (2), override (2), users (2), refer (2), role (2), level (2), targets (2), administrators (2), specify (2), replacement (2), enable_nav_item (2), noone (2), loggedin (2), show_tab (2), visibility (2), dedicated (2), process (2), set (2), where (2), default (2), adimn (2), area (2), details (2), add_meta_box (2), integer (2), between (2), file (2), appear (2), argument (2), items (2), required (2), how (2), own (2), pages (2), guide (2), https (2), web (2), logged, toolbar, terms, service, privacy, contact, gpl, twitter, rss, matt, volunteer, powered, contribute, too, interested, updating, existing, articles, entirely, ones, our, standards, guidelines, help, published, hugo, ashmore, david, cavins, boone, gorges, article, contributors, contents, checking, existed, calling, introduces, autoloading, could, autoloaded, even, isn, causes, reason, now, recommend, wrapped, conditional, 105, suckaz, cooler, present, instead, similar, overrides, exist, welcome, neat, displayed, cool, displaying, settings_sceren_save, saving, first, simple, though, implementation, second, demonstrates, some, advanced, customizations, appropriate, generic, further, one, provides, specific, form, submits, validate, database, outputs, fallback, contexts, system, customize, way, without, unnecessary, reproduction, code, minimum, provide, prominent, uses, generate, output, place, proper, built, different, needed, show, visit, allow, multi, dimensional, related, secondary, under, editing, administration, each, need, those, parse, provided, falling, back, priority, metabox_priority, normal, metabox_context, wrapper, single, plugins, template_file, action, widget, hooked, groups_custom_group_boxes, display_hook, parameter, nav_item_name, nav, item, describing, visible, who, won, translatable, titles, unique, identifier, among, other, places, construction, urls, define, reference, done, write, follows, consists, base, extend, does, integrate, tabs, registering, etc, working, building, make, sure, important, might, ensure, bp_is, makes, easy, add, custom, steps, essentially, created, earlier, versions, found, development, prior, resources, home, download, news, get, involved, bottom, top, search, categories, wayback, machine, http, archive, 20221201072618, timestamps, capture, fail, success, 2023, 2022, 2021, jan, dec, nov, oct, 2013, mar, 2026, captures,

Text of the page (random words):
group extension api buddypress codex 60 captures 07 oct 2013 11 mar 2026 nov dec jan 01 2021 2022 2023 success fail about this capture timestamps the wayback machine http web archive org web 20221201072618 https codex buddypress org developer group extension api skip to content pages categories search top bottom about documentation get involved news support download buddypress codex codex home developer resources group extension api group extension api note this guide is for use with buddypress 1 8 a guide for using the group extension api with earlier versions of bp can be found at https codex buddypress org developer plugin development group extension api prior to bp 1 8 the group extension api makes it very easy to add custom creation steps edit screens navigation items and pages to a group it essentially allows you to create fully functional extensions to buddypress created groups note if you are building a buddypress plugin please make sure you have read how to check if buddypress is active this is very important you might also want to check ensure that the group component is active using the bp_is active function overview the group extension api consists of a base class called bp_group_extension which you extend in your own plugin bp_group_extension does most of the work necessary to integrate your content into bp group creating new navigation tabs registering a step during group creation etc see the examples section for working examples use use bp_group_extension as follows in a plugin file create your own class that extends bp_group_extension in the __construct method pass an array of arguments to parent init arguments are described in the configuration section write any methods that your extension requires see the methods section for available options register your extension with buddypress using bp_register_group_extension configuration in the __construct method of your extension class you should define a set of arguments and pass them to parent init reference the examples to see how this is done possible arguments slug required a unique string identifier for your extension used among other places in the construction of urls name required the translatable name of your extension used as the default value for navigation items and page titles visibility optional public means that your extension will be visible to anyone who can access the group private means it won t defaults to public note buddypress 2 1 0 added the new argument access which should be used when possible nav_item_position optional an integer describing where your extension s tab should appear a number between 1 and 100 is recommended defaults to 81 enable_nav_item optional true for the nav item to be enabled for the current user false otherwise defaults to true note buddypress 2 1 0 added the new argument show_tab which should be used when possible nav_item_name optional the string you want to appear in the navigation tab for your group extension defaults to the of the name parameter described above display_hook optional the wordpress action that the widget display method is hooked to defaults to groups_custom_group_boxes template_file optional the template file that buddypress will use as a wrapper for your display content defaults to groups single plugins php screens optional a multi dimensional array of options related to the three secondary screens available to group extensions create the step dedicated to the extension during the group creation process edit the subtab dedicated to the extension under the admin tab of the group and admin the extension s metabox that appears on the group page when editing via the groups administration dashboard panels each of these screens has a set of configuration options to be described below note that all config values are optional and you only need to override those values where you want to change the default buddypress will parse your screens array using your provided values when available otherwise falling back on the defaults create config options for the create screen position the position of the extension s step in the create a group process an integer between 1 and 100 is recommended defaults to 81 enabled true if you want your extension to have a create step otherwise false defaults to true name the name of the creation step as it appears in the step s navigation tab defaults to the general name value described above slug the string used to create the url of the creation step defaults to the general slug value described above screen_callback the function bp will call to display the content of your create screen buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing screen_save_callback the function bp will call after the extension s create step has been saved buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing edit config options for the edit screen submit_text the text of the submit button on the edit screen defaults to edit enabled true if you want your extension to have a subtab in the group adimn area otherwise false defaults to true name the text that appears in the navigation tab for the extension s edit screen defaults to the general name value described above slug the string used to create the url of the admin tab defaults to the general slug value described above screen_callback the function bp will call to display the content of your admin tab buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing screen_save_callback the function bp will call after the extension s admin tab has been saved buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing admin config options for the admin screen metabox_context the context for your extension s metabox defaults to normal see add_meta_box for more details metabox_priority the priority for your extension s metabox defaults to see add_meta_box for more details enabled true if you want your extension to have a subtab in the group adimn area otherwise false defaults to true name the text that appears in the navigation tab for the extension s edit screen defaults to the general name value described above slug the string used to create the url of the admin tab defaults to the general slug value described above screen_callback the function bp will call to display the content of your admin tab buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing screen_save_callback the function bp will call after the extension s admin tab has been saved buddypress attempts to determine this function automatically see methods below do not change this value unless you know what you re doing access optional which users can visit the extension s tab possible values anyone loggedin member mod admin or noone member mod admin refer to user s role in the current group defaults to anyone for public groups and member for private groups note that the mod level targets only moderators so if you want to allow access for group moderators and administrators specify array mod admin added in buddypress 2 1 0 as a more flexible replacement for visibility show_tab optional which users can see the extension s navigation tab possible values anyone loggedin member mod admin or noone member mod admin refer to user s role in the current group defaults to anyone for public groups and member for private groups note that the mod level targets only moderators so if you want to show the tab to group moderators and administrators specify array mod admin added in buddypress 2 1 0 as a more flexible replacement for enable_nav_item methods bp_group_extension has built in support for a number of different customization methods which you can override in your extension as needed the most prominent of these methods is display which buddypress uses to generate the output of the plugin s main tab your display method should echo markup which bp will automatically place into the proper template for the three screen contexts create edit and admin a flexible system allows you to customize the way that your settings screens work without unnecessary reproduction of code your extension should at minimum provide the following two methods settings_screen outputs the fallback markup for your create edit admin screens settings_screen_save called after changes are submitted from the create edit admin screens this methods should contain the logic necessary to catch settings form submits validate submitted settings and save them to the database if your extension requires further customization to one or more of the screens buddypress provides the following methods which are context specific create_screen create_screen_save edit_screen edit_screen_save admin_screen admin_screen_save if your extension contains any of these methods bp will use them when appropriate otherwise the generic settings_screen or settings_screen_save will be used examples two examples follow the first is a very simple though fully functional implementation of bp_group_extension the second demonstrates some more advanced customizations the bp_is_active groups check is recommended to prevent problems during upgrade or when the groups component is disabled if bp_is_active groups class group_extension_example_1 extends bp_group_extension your __construct method will contain configuration options for your extension and will pass them to parent init function __construct args array slug group extension example 1 name group extension example 1 parent init args display contains the markup that will be displayed on the main plugin tab function display group_id null group_id bp_get_group_id echo what a cool plugin settings_screen is the catch all method for displaying the content of the edit create and dashboard admin panels function settings_screen group_id null setting groups_get_groupmeta group_id group_extension_example_1_setting save your plugin setting here input type text name group_extension_example_1_setting value php echo esc_attr setting php settings_sceren_save contains the catch all logic for saving settings from the edit create and dashboard admin panels function settings_screen_save group_id null setting if isset _post group_extension_example_1_setting setting _post group_extension_example_1_setting groups_update_groupmeta group_id group_extension_example_1_setting setting bp_register_group_extension group_extension_example_1 endif if bp_is_active groups the bp_is_active groups check is recommended to prevent problems during upgrade or when the groups component is disabled if bp_is_active groups class group_extension_example_2 extends bp_group_extension here you can see more customization of the config options function __construct args array slug group extension example 2 name group extension example 2 nav_item_position 105 screens array edit array name ge example 2 changes the text of the submit button on the edit page submit_text submit suckaz create array position 100 parent init args function display group_id null group_id bp_get_group_id echo this plugin is 2x cooler function settings_screen group_id null setting groups_get_groupmeta group_id group_extension_example_2_setting save your plugin setting here input type text name group_extension_example_2_setting value php echo esc_attr setting php function settings_screen_save group_id null setting isset _post group_extension_example_2_setting _post group_extension_example_2_setting groups_update_groupmeta group_id group_extension_example_2_setting setting create_screen is an optional method that when present will be used instead of settings_screen in the context of group creation similar overrides exist via the following methods create_screen_save edit_screen edit_screen_save admin_screen admin_screen_save function create_screen group_id null setting groups_get_groupmeta group_id group_extension_example_2_setting welcome to your new group you are neat save your plugin setting here input type text name group_extension_example_2_setting value php echo esc_attr setting php bp_register_group_extension group_extension_example_2 endif updated recommendations for buddypress 2 6 please note before buddypress 2 6 we recommended checking that the bp_group_extension class existed before calling it bp 2 6 introduces class autoloading so the bp_group_extension class could be autoloaded even if the groups component isn t active which causes problems for this reason we now recommend that extensions of the bp_group_extension class be wrapped in an if bp_is_active groups conditional contents overview use configuration methods examples updated recommendations for buddypress 2 6 log in register article contributors 30 boone gorges 4 david cavins 4 hugo ashmore updated 6 years ago published 9 years ago want to help the buddypress codex is volunteer powered which means you can contribute too if you re interested in updating existing articles or creating entirely new ones please read our codex standards guidelines see also wordpress org bbpress org buddypress org matt blog rss follow buddypress on twitter gpl contact us privacy terms of service skip to toolbar wordpress org about wordpress documentation support forums feedback developer trac developer blog bbpress org about bbpress documentation support forums feedback developer trac developer blog buddypress org about buddypress documentation support forums feedback developer trac developer blog buddypress org log in anonymous anonymous not logged in register log in