Changeset 7399
- Timestamp:
- 10/08/2013 08:58:05 PM (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/bp-core/bp-core-component.php
r7370 r7399 119 119 120 120 /** 121 * Component global variables 122 * 123 * @since BuddyPress (1.5) 124 * 125 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id' 126 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug' 127 * 128 * @param array $args Optional 121 * Set up component global variables. 122 * 123 * @since BuddyPress (1.5) 124 * 125 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'. 126 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug'. 127 * 128 * @param array $args { 129 * All values are optional. 130 * @type string $slug The component slug. Used to construct certain 131 * URLs, such as 'friends' in 132 * http://example.com/members/joe/friends/ 133 * @type string $root_slug The component root slug. Note that this 134 * value is generally unused if the component 135 * has a root directory (the slug will be 136 * overridden by the post_name of the 137 * directory page). 138 * @type bool $has_directory Set to true if the component requires 139 * an associated WordPress page. 140 * @type string $notification_callback The callable function that 141 * formats the component's 142 * notifications. 143 * @type string $search_term Optional. The placeholder text in the 144 * component directory search box. Eg, 145 * 'Search Groups...'. 146 * @type array $global_tables Optional. An array of database table 147 * names. 148 * } 129 149 */ 130 150 public function setup_globals( $args = array() ) { … … 200 220 * 201 221 * @uses do_action() Calls 'bp_{@link bp_Component::name}includes' 222 * 223 * @param array $includes An array of file names, or file name chunks, 224 * to be parsed and then included. 202 225 */ 203 226 public function includes( $includes = array() ) { … … 292 315 293 316 /** 294 * Setup the navigation 295 * 296 * @param array $main_nav Optional 297 * @param array $sub_nav Optional 317 * Set up component navigation. 318 * 319 * @see bp_core_new_nav_item() For a description of the $main_nav 320 * parameter formatting. 321 * @see bp_core_new_subnav_item() For a description of how each item 322 * in the $sub_nav parameter array should be formatted. 323 * 324 * @param array $main_nav Optional. Passed directly to 325 * bp_core_new_nav_item(). See that function for 326 * a description. 327 * @param array $sub_nav Optional. Multidimensional array, each item in 328 * which is passed to bp_core_new_subnav_item(). 329 * See that function for a description. 298 330 */ 299 331 public function setup_nav( $main_nav = array(), $sub_nav = array() ) { … … 316 348 317 349 /** 318 * Setup the Toolbar 319 * 350 * Set up the component entries in the WordPress Admin Bar. 351 * 352 * @see WP_Admin_Bar::add_menu() for a description of the syntax 353 * required by each item in the $wp_admin_nav parameter array. 320 354 * @global obj $wp_admin_bar 321 * @param array $wp_admin_menus 355 * 356 * @param array $wp_admin_nav An array of nav item arguments. Each item 357 * in this parameter array is passed to 358 * WP_Admin_Bar::add_menu(). See that method 359 * for a description of the required syntax 360 * for each item. 322 361 */ 323 362 public function setup_admin_bar( $wp_admin_nav = array() ) {
Note: See TracChangeset
for help on using the changeset viewer.