Changeset 10108 for trunk/src/bp-core/bp-core-component.php
- Timestamp:
- 09/13/2015 02:02:56 AM (10 years ago)
- File:
-
- 1 edited
-
trunk/src/bp-core/bp-core-component.php (modified) (46 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-core/bp-core-component.php
r10052 r10108 23 23 * @subpackage Component 24 24 * 25 * @since BuddyPress (1.5.0)25 * @since 1.5.0 26 26 */ 27 27 class BP_Component { … … 96 96 * Placeholder text for component directory search box. 97 97 * 98 * @since BuddyPress (1.5.0)98 * @since 1.5.0 99 99 * @var string $search_string 100 100 */ … … 104 104 * Root slug for the component. 105 105 * 106 * @since BuddyPress (1.5.0)106 * @since 1.5.0 107 107 * @var string $root_slug 108 108 */ … … 112 112 * Metadata tables for the component (if applicable). 113 113 * 114 * @since BuddyPress (2.0.0)114 * @since 2.0.0 115 115 * 116 116 * @var array … … 121 121 * Global tables for the component (if applicable). 122 122 * 123 * @since BuddyPress (2.0.0)123 * @since 2.0.0 124 124 * 125 125 * @var array … … 132 132 * Component loader. 133 133 * 134 * @since BuddyPress (1.5.0)135 * @since BuddyPress (1.9.0)Added $params as a parameter.136 * @since BuddyPress (2.3.0)Added $params['features'] as a configurable value.134 * @since 1.5.0 135 * @since 1.9.0 Added $params as a parameter. 136 * @since 2.3.0 Added $params['features'] as a configurable value. 137 137 * 138 138 * @param string $id Unique ID. Letters, numbers, and underscores only. … … 185 185 * Set up component global variables. 186 186 * 187 * @since BuddyPress (1.5)187 * @since 1.5.0 188 188 * 189 189 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'. … … 228 228 * Filters the slug to be used for the permalink URI chunk after root. 229 229 * 230 * @since BuddyPress (1.5.0)230 * @since 1.5.0 231 231 * 232 232 * @param string $value Slug to use in permalink URI chunk. … … 237 237 * Filters the slug used for root directory. 238 238 * 239 * @since BuddyPress (1.5.0)239 * @since 1.5.0 240 240 * 241 241 * @param string $value Root directory slug. … … 246 246 * Filters the component's top-level directory if available. 247 247 * 248 * @since BuddyPress (1.5.0)248 * @since 1.5.0 249 249 * 250 250 * @param bool $value Whether or not there is a top-level directory. … … 255 255 * Filters the component's directory title. 256 256 * 257 * @since BuddyPress (2.0.0)257 * @since 2.0.0 258 258 * 259 259 * @param string $value Title to use for the directory. … … 264 264 * Filters the placeholder text for search inputs for component. 265 265 * 266 * @since BuddyPress (1.5.0)266 * @since 1.5.0 267 267 * 268 268 * @param string $value Name to use in search input placeholders. … … 273 273 * Filters the callable function that formats the component's notifications. 274 274 * 275 * @since BuddyPress (1.5.0)275 * @since 1.5.0 276 276 * 277 277 * @param string $value Function callback. … … 299 299 * This is a dynamic hook that is based on the component string ID. 300 300 * 301 * @since BuddyPress (1.5.0)301 * @since 1.5.0 302 302 */ 303 303 do_action( 'bp_' . $this->id . '_setup_globals' ); … … 327 327 * - ./bp-my_component/bp-my_component-actions.php 328 328 * 329 * @since BuddyPress (1.5.0)329 * @since 1.5.0 330 330 * 331 331 * @uses do_action() Calls 'bp_{@link bp_Component::name}includes'. … … 370 370 * This is a dynamic hook that is based on the component string ID. 371 371 * 372 * @since BuddyPress (1.5.0)372 * @since 1.5.0 373 373 */ 374 374 do_action( 'bp_' . $this->id . '_includes' ); … … 378 378 * Set up the actions. 379 379 * 380 * @since BuddyPress (1.5.0)380 * @since 1.5.0 381 381 * 382 382 * @uses add_action() To add various actions. … … 436 436 * This is a dynamic hook that is based on the component string ID. 437 437 * 438 * @since BuddyPress (1.5.0)438 * @since 1.5.0 439 439 */ 440 440 do_action( 'bp_' . $this->id . '_setup_actions' ); … … 444 444 * Set up the canonical URL stack for this component. 445 445 * 446 * @since BuddyPress (2.1.0)446 * @since 2.1.0 447 447 */ 448 448 public function setup_canonical_stack() {} … … 481 481 * This is a dynamic hook that is based on the component string ID. 482 482 * 483 * @since BuddyPress (1.5.0)483 * @since 1.5.0 484 484 */ 485 485 do_action( 'bp_' . $this->id . '_setup_nav' ); … … 515 515 * This is a dynamic hook that is based on the component string ID. 516 516 * 517 * @since BuddyPress (1.9.0)517 * @since 1.9.0 518 518 * 519 519 * @param array $wp_admin_nav Array of navigation items to add. … … 541 541 * This is a dynamic hook that is based on the component string ID. 542 542 * 543 * @since BuddyPress (1.5.0)543 * @since 1.5.0 544 544 */ 545 545 do_action( 'bp_' . $this->id . '_setup_admin_bar' ); … … 549 549 * Set up the component title. 550 550 * 551 * @since BuddyPress (1.5.0)551 * @since 1.5.0 552 552 * 553 553 * @uses do_action() Calls 'bp_{@link bp_Component::name}_setup_title'. … … 560 560 * This is a dynamic hook that is based on the component string ID. 561 561 * 562 * @since BuddyPress (1.5.0)562 * @since 1.5.0 563 563 */ 564 564 do_action( 'bp_' . $this->id . '_setup_title' ); … … 568 568 * Setup component-specific cache groups. 569 569 * 570 * @since BuddyPress (2.2.0)570 * @since 2.2.0 571 571 * 572 572 * @uses do_action() Calls 'bp_setup_{@link bp_Component::name}_cache_groups'. … … 579 579 * This is a dynamic hook that is based on the component string ID. 580 580 * 581 * @since BuddyPress (2.2.0)581 * @since 2.2.0 582 582 */ 583 583 do_action( 'bp_' . $this->id . '_setup_cache_groups' ); … … 587 587 * Register global tables for the component, so that it may use WordPress's database API. 588 588 * 589 * @since BuddyPress (2.0.0)589 * @since 2.0.0 590 590 * 591 591 * @param array $tables Table names to register. … … 600 600 * *all* tables, use the 'bp_core_get_table_prefix' filter instead. 601 601 * 602 * @since BuddyPress (1.6.0)602 * @since 1.6.0 603 603 */ 604 604 $tables = apply_filters( 'bp_' . $this->id . '_global_tables', $tables ); … … 619 619 * This is a dynamic hook that is based on the component string ID. 620 620 * 621 * @since BuddyPress (2.0.0)621 * @since 2.0.0 622 622 */ 623 623 do_action( 'bp_' . $this->id . '_register_global_tables' ); … … 630 630 * compatibility with the WordPress metadata API. 631 631 * 632 * @since BuddyPress (2.0.0)632 * @since 2.0.0 633 633 * 634 634 * @param array $tables Table names to register. … … 644 644 * *all* tables, use the 'bp_core_get_table_prefix' filter instead. 645 645 * 646 * @since BuddyPress (2.0.0)646 * @since 2.0.0 647 647 */ 648 648 $tables = apply_filters( 'bp_' . $this->id . '_meta_tables', $tables ); … … 666 666 * This is a dynamic hook that is based on the component string ID. 667 667 * 668 * @since BuddyPress (2.0.0)668 * @since 2.0.0 669 669 */ 670 670 do_action( 'bp_' . $this->id . '_register_meta_tables' ); … … 674 674 * Set up the component post types. 675 675 * 676 * @since BuddyPress (1.5.0)676 * @since 1.5.0 677 677 * 678 678 * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_post_types'. … … 685 685 * This is a dynamic hook that is based on the component string ID. 686 686 * 687 * @since BuddyPress (1.5.0)687 * @since 1.5.0 688 688 */ 689 689 do_action( 'bp_' . $this->id . '_register_post_types' ); … … 693 693 * Register component-specific taxonomies. 694 694 * 695 * @since BuddyPress (1.5.0)695 * @since 1.5.0 696 696 * 697 697 * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_taxonomies'. … … 704 704 * This is a dynamic hook that is based on the component string ID. 705 705 * 706 * @since BuddyPress (1.5.0)706 * @since 1.5.0 707 707 */ 708 708 do_action( 'bp_' . $this->id . '_register_taxonomies' ); … … 712 712 * Add any additional rewrite tags. 713 713 * 714 * @since BuddyPress (1.5.0)714 * @since 1.5.0 715 715 * 716 716 * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_tags'. … … 723 723 * This is a dynamic hook that is based on the component string ID. 724 724 * 725 * @since BuddyPress (1.5.0)725 * @since 1.5.0 726 726 */ 727 727 do_action( 'bp_' . $this->id . '_add_rewrite_tags' ); … … 731 731 * Add any additional rewrite rules. 732 732 * 733 * @since BuddyPress (1.9.0)733 * @since 1.9.0 734 734 * 735 735 * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_rules'. … … 742 742 * This is a dynamic hook that is based on the component string ID. 743 743 * 744 * @since BuddyPress (1.9.0)744 * @since 1.9.0 745 745 */ 746 746 do_action( 'bp_' . $this->id . '_add_rewrite_rules' ); … … 750 750 * Add any permalink structures. 751 751 * 752 * @since BuddyPress (1.9)752 * @since 1.9.0 753 753 * 754 754 * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'. … … 761 761 * This is a dynamic hook that is based on the component string ID. 762 762 * 763 * @since BuddyPress (1.9.0)763 * @since 1.9.0 764 764 */ 765 765 do_action( 'bp_' . $this->id . '_add_permastructs' ); … … 769 769 * Allow components to parse the main query. 770 770 * 771 * @since BuddyPress (1.9)771 * @since 1.9.0 772 772 * 773 773 * @uses do_action() Calls 'bp_{@link bp_Component::name}_parse_query'. … … 782 782 * This is a dynamic hook that is based on the component string ID. 783 783 * 784 * @since BuddyPress (1.9.0)784 * @since 1.9.0 785 785 * 786 786 * @param object $query Main WP_Query object. Passed by reference. … … 792 792 * Generate any additional rewrite rules. 793 793 * 794 * @since BuddyPress (1.5)794 * @since 1.5.0 795 795 * 796 796 * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'. … … 803 803 * This is a dynamic hook that is based on the component string ID. 804 804 * 805 * @since BuddyPress (1.5.0)805 * @since 1.5.0 806 806 */ 807 807 do_action( 'bp_' . $this->id . '_generate_rewrite_rules' );
Note: See TracChangeset
for help on using the changeset viewer.