Meta tags:
description= ;
keywords= wordpress buddypress bbpress community support forums;
Headings (most frequently used words):
bp, string, array, object, bool, buddypress, codex, the, global, article, contributors, want, to, help, root_components, root_domain, loggedin_user, displayed_user, current_component, current_action, action_variables, current_item, is_single_item, default_component, bp_nav, bp_users_nav, bp_options_nav, bp_options_title, bp_options_avatar, grav_default, is_item_admin, is_item_mod, component_name,
Text of the page (most frequently used words):
the (142), for (31), user (30), #component (25), example (22), org (21), this (18), item (18), array (17), url (16), buddypress (15), name (15), that (15), you (14), group (13), would (13), http (13), groups (12), navigation (11), and (10), currently (10), when (10), page (10), developer (9), used (9), are (9), each (9), root (9), logged (8), will (8), string (8), viewing (8), profile (8), members (8), can (7), function (7), content (7), sub (7), use (7), display (7), current_component (7), not (6), codex (6), global (6), slug (6), avatar (6), list (6), link (6), bp_nav (6), current_action (6), blog (5), about (5), wordpress (5), andy (5), items (5), all (5), settings (5), set (5), true (5), messages (5), using (5), then (5), displayed_user (5), support (4), documentation (4), below (4), privileges (4), being (4), under (4), bp_options_nav (4), nav (4), render (4), top (4), bp_users_nav (4), join (4), loggedin_user (4), log (3), trac (3), feedback (3), forums (3), bbpress (3), which (3), format (3), into (3), with (3), able (3), components (3), object (3), same (3), but (3), admin (3), bool (3), setting (3), viewed (3), title (3), displayed (3), css (3), rendered (3), html (3), css_id (3), main (3), level (3), key (3), contains (3), view (3), only (3), value (3), installation (3), is_single_item (3), theme (3), current_item (3), root_components (3), action (3), domain (3), echo (3), register (2), anonymous (2), skip (2), also (2), want (2), ago (2), something (2), readable (2), end (2), component_name (2), listed (2), step (2), is_item_admin (2), site (2), always (2), any (2), default (2), gravatar (2), other (2), than (2), were (2), shown (2), menu (2), add (2), should (2), username (2), default_component (2), parameter (2), active (2), member (2), where (2), chocolate (2), working (2), within (2), current (2), become (2), variables (2), after (2), values (2), action_variables (2), leave (2), out (2), fullname (2), looking (2), run (2), bp_dump (2), pre (2), strong (2), good (2), look (2), may (2), get (2), web (2), toolbar, terms, service, privacy, contact, gpl, follow, twitter, see, rss, matt, volunteer, powered, means, contribute, too, interested, updating, existing, articles, creating, entirely, new, ones, please, read, our, standards, guidelines, help, updated, published, years, month, ntoronto, lena, stergatou, peatling, article, contributors, notifications, format_notification_function, activity, format_activity_function, primary, table, table_name, image, directory, specific, images, image_base, replace, access, common, exactly, moderation, basically, down, from, moderators, is_item_mod, give, particular, piece, admins, giving, them, override, creator, type, has, changed, area, general, grav_default, associated, instance, bp_options_avatar, ours, bp_options_title, mapped, via, its, options, follows, different, though, contain, links, viewable, messaging, itself, containing, three, bp_core_add_nav_item, visits, single, forces, normally, have, created, custom, such, templates, muffins, install, need, offset, one, make, way, again, remaining, sections, section, chunks, between, forward, slashes, carried, usually, next, 345, equal, hold, these, return, false, your, wpmu, root_domain, because, both, added, bp_core_add_root_component, component_slug, here, description, add_action, die, print_r, foreach, core, php, take, now, configuration, needs, throughout, find, first, contents, over, everything, glimpse, how, things, work, behind, scenes, instead, following, inside, deprecated, resources, home, download, news, involved, bottom, search, categories, pages, wayback, machine, archive, 20221201064203, https, timestamps, capture, fail, success, 2023, 2022, 2021, jan, dec, nov, aug, 2013, 2026, captures,
Text of the page (random words):
the bp global buddypress codex 45 captures 13 aug 2013 20 may 2026 nov dec jan 01 2021 2022 2023 success fail about this capture timestamps the wayback machine http web archive org web 20221201064203 https codex buddypress org developer the bp global skip to content pages categories search top bottom about documentation get involved news support download buddypress codex codex home developer resources the bp global the bp global the bp global is deprecated instead you should use the following inside a function bp buddypress now the bp contains all of the variables and configuration settings that buddypress needs to use throughout an installation as a developer you may find a good first step is to use the function below to render out the contents you ll then be able to look over everything and get a glimpse into how things work behind the scenes add this to the top of bp core php and you ll be able to take a good look at it 1 2 3 4 5 6 7 8 9 10 11 12 function bp_dump global bp foreach array bp as key value echo pre echo strong key strong br print_r value echo pre die add_action wp bp_dump here s an description of each setting bp root_components array the slug of each component that can run in the root of the site for example groups is a root component because it can run both on http example org members andy groups but also in the root http example org groups my group settings can be added using the function bp_core_add_root_component component_slug bp root_domain string the domain of the root blog on your wpmu installation bp loggedin_user object contains the id url and name of the currently logged in user bp loggedin_user id the user id of the user bp loggedin_user domain the profile page url of the user bp loggedin_user fullname the display name of the user bp displayed_user object if you re looking at a user s profile page or any page under http example org members username then displayed_user will hold the id url and name of that user if you re not currently looking at a user these values will return false bp displayed_user id the user id of the user bp displayed_user domain the profile page url of the user bp displayed_user fullname the display name of the user bp current_component string the slug of the component that is currently being viewed for example on the url http example org members andy messages the current_component would be messages on http example org groups my group current_component would be groups if no component is being viewed for example on the root then current_component will equal bp default_component bp current_action string the action being carried out within a component current action usually always is the next parameter in the url after bp current_component for example the url http example org members andy messages view 345 current_action would be view if bp current_component is in the list in bp root_components and we are in the root not members http example org groups my group join current_action would be join where as my group would be bp current_item bp action_variables array action variables are all the remaining sections of the url after bp current_action each section chunks of the url between forward slashes become an item in the array for example the url http example org members andy groups my groups leave 15 the values leave and 15 would each be items in the action_variables array bp current_item string only used when bp current_component is in the list of components in bp root_components if we are working in the root of the install but within a buddypress component we need to offset bp current_action by one to make way for a content item for example http example org groups my group join the current_item would be my group as it is the current content item that we are viewing bp current_action would then become join again this is only when working in the root and not under the members slug bp is_single_item bool this parameter is set as true if we are viewing a single content item in the root of an installation for example if we are viewing a group under the url http example org groups my group then is_single_item will be true this forces wordpress to use the currently active buddypress member theme to display the content where as it would normally have used the active wordpress theme if you created a custom component with a url such as http example org muffins chocolate you d want to set bp is_single_item to true when viewing chocolate so that the buddypress member theme can be used to display templates bp default_component string when the user visits http example org members username which component should be shown this is the slug value of that component default profile bp bp_nav array this is the array used to render each component navigation menu item for the logged in user each component is an item of the array which in itself is an array containing three items listed below you can add to this array by using the function bp_core_add_nav_item bp bp_nav name the display name for the component bp bp_nav link the url to the main page of the component using the currently logged in user s profile link bp bp_nav css_id the css id to use for the navigation item when it is rendered to the page in html bp bp_users_nav array this is the array used to render each component navigation menu item for the displayed user when you view a user that is not you it follows the same format as bp bp_nav this navigation array is different though as it will not contain links to components that are only viewable by a logged in user for example messaging bp bp_users_nav name the display name for the component bp bp_users_nav link the url to the main page of the component using the currently displayed user s profile link bp bp_users_nav css_id the css id to use for the navigation item when it is rendered to the page in html bp bp_options_nav array this is the array used to render all of the sub navigation items for the bp bp_nav array each item is mapped to a top level nav item via its array key each sub level nav item contains the same options as the top level nav items shown below bp bp_options_nav name the display name for the sub nav item bp bp_options_nav link the url to the main page of the component using the currently logged in user s profile link bp bp_options_nav css_id the css id to use for the navigation item when it is rendered to the page in html bp bp_options_title string this is the title for the currently displayed sub navigation item list for example when viewing the messages component the title of the sub navigation item list would be my messages if we were viewing a user s profile other than ours the title for the sub navigation item list would be the name of the user bp bp_options_avatar string this is the avatar associated with the sub navigation item list for instance if we are viewing a user other than the user logged in the avatar would be that user s avatar if we were viewing a group the avatar would be that group s avatar bp grav_default string the default setting for gravatar type when the user has no avatar or gravatar set this is changed in the wp admin area under buddypress general settings bp is_item_admin bool this setting can be used to give a user admin privileges on a particular piece of content for site admins this is always set to true giving them override privileges on any content for example on the groups component this is set to true if the currently logged in user is the creator of a group and that group is currently being viewed bp is_item_mod bool exactly the same as bp is_item_admin but for moderation privileges basically a step down from admin privileges this is used in the groups component for group moderators bp component_name object replace component_name with the name of a component and you will be able to access all of the settings for that component common settings for all components are listed below image_base the image directory for component specific images table_name the name of the primary table used by the component slug the url slug for the component format_activity_function the function name that will format activity items into something readable by the end user format_notification_function the function name that will format notifications into something readable by the end user log in register article contributors 22 andy peatling 5 lena stergatou 3 ntoronto updated 1 month ago published 14 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
|