Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (10 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Core component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-dependency.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * Plugin Dependency Action Hooks.
     
    1615 *
    1716 * @todo use anonymous functions when PHP minimum requirement allows (5.3)
     17 *
     18 * @package BuddyPress
     19 * @subpackage Core
    1820 */
    1921
     
    2628     * Fires inside the 'bp_include' function, where plugins should include files.
    2729     *
    28      * @since BuddyPress (1.2.5)
     30     * @since 1.2.5
    2931     */
    3032    do_action( 'bp_include' );
     
    3941     * Fires inside the 'bp_setup_components' function, where plugins should initialize components.
    4042     *
    41      * @since BuddyPress (1.6.0)
     43     * @since 1.6.0
    4244     */
    4345    do_action( 'bp_setup_components' );
     
    5254     * Fires inside the 'bp_setup_canonical_stack' function, where plugins should set up their canonical URL.
    5355     *
    54      * @since BuddyPress (2.1.0)
     56     * @since 2.1.0
    5557     */
    5658    do_action( 'bp_setup_canonical_stack' );
     
    6062 * Fire the 'bp_register_taxonomies' action, where plugins should register taxonomies.
    6163 *
    62  * @since BuddyPress (2.2.0)
     64 * @since 2.2.0
    6365 */
    6466function bp_register_taxonomies() {
     
    6769     * Fires inside the 'bp_register_taxonomies' function, where plugins should register taxonomies.
    6870     *
    69      * @since BuddyPress (2.2.0)
     71     * @since 2.2.0
    7072     */
    7173    do_action( 'bp_register_taxonomies' );
     
    8082     * Fires inside the 'bp_setup_globals' function, where plugins should initialize global settings.
    8183     *
    82      * @since BuddyPress (1.2.0)
     84     * @since 1.2.0
    8385     */
    8486    do_action( 'bp_setup_globals' );
     
    9395     * Fires inside the 'bp_setup_nav' function, where plugins should register their navigation items.
    9496     *
    95      * @since BuddyPress (1.2.0)
     97     * @since 1.2.0
    9698     */
    9799    do_action( 'bp_setup_nav' );
     
    109111         * This hook will only fire if bp_use_wp_admin_bar() returns true.
    110112         *
    111          * @since BuddyPress (1.5.0)
     113         * @since 1.5.0
    112114         */
    113115        do_action( 'bp_setup_admin_bar' );
     
    123125     * Fires inside the 'bp_setup_title' function, where plugins should modify the page title.
    124126     *
    125      * @since BuddyPress (1.5.0)
     127     * @since 1.5.0
    126128     */
    127129    do_action( 'bp_setup_title' );
     
    136138     * Fires inside the 'bp_register_widgets' function, where plugins should register widgets.
    137139     *
    138      * @since BuddyPress (1.2.0)
     140     * @since 1.2.0
    139141     */
    140142    do_action( 'bp_register_widgets' );
     
    144146 * Fire the 'bp_register_member_types' action, where plugins should register member types.
    145147 *
    146  * @since BuddyPress (2.3.0)
     148 * @since 2.3.0
    147149 */
    148150function bp_register_member_types() {
     
    151153     * Fires inside bp_register_member_types(), so plugins can register member types.
    152154     *
    153      * @since BuddyPress (2.3.0)
     155     * @since 2.3.0
    154156     */
    155157    do_action( 'bp_register_member_types' );
     
    159161 * Fire the 'bp_setup_cache_groups' action, where cache groups are registered.
    160162 *
    161  * @since BuddyPress (2.2.0)
     163 * @since 2.2.0
    162164 */
    163165function bp_setup_cache_groups() {
     
    166168     * Fires inside the 'bp_setup_cache_groups' function, where cache groups are registered.
    167169     *
    168      * @since BuddyPress (2.2.0)
     170     * @since 2.2.0
    169171     */
    170172    do_action( 'bp_setup_cache_groups' );
     
    193195     * Fires to set up the current user setup process.
    194196     *
    195      * @since BuddyPress (1.7.0)
     197     * @since 1.7.0
    196198     */
    197199    do_action( 'bp_setup_current_user' );
     
    206208     * Fires inside the 'bp_init' function, BuddyPress' main initialization hook.
    207209     *
    208      * @since BuddyPress (1.2.0)
     210     * @since 1.2.0
    209211     */
    210212    do_action( 'bp_init' );
     
    221223     * Fires inside the 'bp_loaded' function, which fires after BP's core plugin files have been loaded.
    222224     *
    223      * @since BuddyPress (1.2.5)
     225     * @since 1.2.5
    224226     */
    225227    do_action( 'bp_loaded' );
     
    236238     * Fires inside the 'bp_ready' function, which runs after BP is set up and the page is about to render.
    237239     *
    238      * @since BuddyPress (1.6.0)
     240     * @since 1.6.0
    239241     */
    240242    do_action( 'bp_ready' );
     
    252254     * Fires inside the 'bp_actions' function, which runs just before rendering.
    253255     *
    254      * @since BuddyPress (1.5.0)
     256     * @since 1.5.0
    255257     */
    256258    do_action( 'bp_actions' );
     
    270272     * Runs just after 'bp_actions'. Use this hook to attach your template loaders.
    271273     *
    272      * @since BuddyPress (1.5.0)
     274     * @since 1.5.0
    273275     */
    274276    do_action( 'bp_screens' );
     
    287289     * Hooked to 'widgets_init'.
    288290     *
    289      * @since BuddyPress (1.6.0)
     291     * @since 1.6.0
    290292     */
    291293    do_action ( 'bp_widgets_init' );
     
    310312 * who do not have the proper permission to access certain content.
    311313 *
    312  * @since BuddyPress (1.6.0)
     314 * @since 1.6.0
    313315 *
    314316 * @uses do_action()
     
    319321     * Fires inside the 'bp_template_redirect' function.
    320322     *
    321      * @since BuddyPress (1.6.0)
     323     * @since 1.6.0
    322324     */
    323325    do_action( 'bp_template_redirect' );
     
    331333 * The main action used registering theme directories.
    332334 *
    333  * @since BuddyPress (1.5.0)
     335 * @since 1.5.0
    334336 *
    335337 * @uses do_action()
     
    342344     * The main action used registering theme directories.
    343345     *
    344      * @since BuddyPress (1.7.0)
     346     * @since 1.7.0
    345347     */
    346348    do_action( 'bp_register_theme_directory' );
     
    352354 * The main action used registering theme packages.
    353355 *
    354  * @since BuddyPress (1.7.0)
     356 * @since 1.7.0
    355357 *
    356358 * @uses do_action()
     
    361363     * Fires inside the 'bp_register_theme_packages' function.
    362364     *
    363      * @since BuddyPress (1.7.0)
     365     * @since 1.7.0
    364366     */
    365367    do_action( 'bp_register_theme_packages' );
     
    369371 * Fire the 'bp_enqueue_scripts' action, where BP enqueues its CSS and JS.
    370372 *
    371  * @since BuddyPress (1.6.0)
     373 * @since 1.6.0
    372374 *
    373375 * @uses do_action() Calls 'bp_enqueue_scripts'.
     
    378380     * Fires inside the 'bp_enqueue_scripts' function, where BP enqueues its CSS and JS.
    379381     *
    380      * @since BuddyPress (1.6.0)
     382     * @since 1.6.0
    381383     */
    382384    do_action ( 'bp_enqueue_scripts' );
     
    386388 * Fire the 'bp_add_rewrite_tag' action, where BP adds its custom rewrite tags.
    387389 *
    388  * @since BuddyPress (1.8.0)
     390 * @since 1.8.0
    389391 *
    390392 * @uses do_action() Calls 'bp_add_rewrite_tags'.
     
    395397     * Fires inside the 'bp_add_rewrite_tags' function, where BP adds its custom rewrite tags.
    396398     *
    397      * @since BuddyPress (1.8.0)
     399     * @since 1.8.0
    398400     */
    399401    do_action( 'bp_add_rewrite_tags' );
     
    403405 * Fire the 'bp_add_rewrite_rules' action, where BP adds its custom rewrite rules.
    404406 *
    405  * @since BuddyPress (1.9.0)
     407 * @since 1.9.0
    406408 *
    407409 * @uses do_action() Calls 'bp_add_rewrite_rules'.
     
    412414     * Fires inside the 'bp_add_rewrite_rules' function, where BP adds its custom rewrite rules.
    413415     *
    414      * @since BuddyPress (1.9.0)
     416     * @since 1.9.0
    415417     */
    416418    do_action( 'bp_add_rewrite_rules' );
     
    420422 * Fire the 'bp_add_permastructs' action, where BP adds its BP-specific permalink structure.
    421423 *
    422  * @since BuddyPress (1.9.0)
     424 * @since 1.9.0
    423425 *
    424426 * @uses do_action() Calls 'bp_add_permastructs'.
     
    429431     * Fires inside the 'bp_add_permastructs' function, where BP adds its BP-specific permalink structure.
    430432     *
    431      * @since BuddyPress (1.9.0)
     433     * @since 1.9.0
    432434     */
    433435    do_action( 'bp_add_permastructs' );
     
    440442 * BuddyPress-specific functionality.
    441443 *
    442  * @since BuddyPress (1.6.0)
     444 * @since 1.6.0
    443445 *
    444446 * @uses do_action() Calls 'bp_setup_theme'.
     
    449451     * Fires inside the 'bp_setup_theme' function.
    450452     *
    451      * @since BuddyPress (1.6.0)
     453     * @since 1.6.0
    452454     */
    453455    do_action ( 'bp_setup_theme' );
     
    464466 * before our theme compatibility layer kicks in.
    465467 *
    466  * @since BuddyPress (1.6.0)
     468 * @since 1.6.0
    467469 *
    468470 * @uses do_action() Calls 'bp_after_setup_theme'.
     
    473475     * Fires inside the 'bp_after_setup_theme' function.
    474476     *
    475      * @since BuddyPress (1.7.0)
     477     * @since 1.7.0
    476478     */
    477479    do_action ( 'bp_after_setup_theme' );
     
    483485 * Fire the 'bp_request' filter, a piggy-back of WP's 'request'.
    484486 *
    485  * @since BuddyPress (1.7.0)
     487 * @since 1.7.0
    486488 *
    487489 * @see WP::parse_request() for a description of parameters.
     
    496498     * Filters the query_vars for the current request.
    497499     *
    498      * @since BuddyPress (1.7.0)
     500     * @since 1.7.0
    499501     *
    500502     * @param array $query_vars Array of query variables.
     
    506508 * Fire the 'bp_login_redirect' filter, a piggy-back of WP's 'login_redirect'.
    507509 *
    508  * @since BuddyPress (1.7.0)
     510 * @since 1.7.0
    509511 *
    510512 * @param string $redirect_to     See 'login_redirect'.
     
    520522     * Filters the URL to redirect to after login.
    521523     *
    522      * @since BuddyPress (1.7.0)
     524     * @since 1.7.0
    523525     *
    524526     * @param string           $redirect_to     The redirect destination URL.
     
    534536 * Hooked to 'template_include'.
    535537 *
    536  * @since BuddyPress (1.6.0)
     538 * @since 1.6.0
    537539 *
    538540 * @uses apply_filters()
     
    547549     * Filters the template to use with template_include.
    548550     *
    549      * @since BuddyPress (1.6.0)
     551     * @since 1.6.0
    550552     *
    551553     * @param string $template The path of the template to include.
     
    557559 * Fire the 'bp_generate_rewrite_rules' action, where BP generates its rewrite rules.
    558560 *
    559  * @since BuddyPress (1.7.0)
     561 * @since 1.7.0
    560562 *
    561563 * @uses do_action() Calls 'bp_generate_rewrite_rules' with {@link WP_Rewrite}.
     
    568570     * Fires inside the 'bp_generate_rewrite_rules' function.
    569571     *
    570      * @since BuddyPress (1.7.0)
     572     * @since 1.7.0
    571573     *
    572574     * @param WP_Rewrite $wp_rewrite WP_Rewrite object. Passed by reference.
     
    580582 * Filter the allowed themes list for BuddyPress-specific themes.
    581583 *
    582  * @since BuddyPress (1.7.0)
     584 * @since 1.7.0
    583585 *
    584586 * @uses apply_filters() Calls 'bp_allowed_themes' with the allowed themes list.
     
    593595     * Filters the allowed themes list for BuddyPress-specific themes.
    594596     *
    595      * @since BuddyPress (1.7.0)
     597     * @since 1.7.0
    596598     *
    597599     * @param string $template The path of the template to include.
     
    605607 * The main action used for handling theme-side POST requests.
    606608 *
    607  * @since BuddyPress (1.9.0)
     609 * @since 1.9.0
    608610 * @uses do_action()
    609611 */
     
    629631     * the scope of the 'action' without needing to check it in your function.
    630632     *
    631      * @since BuddyPress (1.9.0)
     633     * @since 1.9.0
    632634     */
    633635    do_action( 'bp_post_request_' . $action );
     
    638640     * Use this static action if you don't mind checking the 'action' yourself.
    639641     *
    640      * @since BuddyPress (1.9.0)
     642     * @since 1.9.0
    641643     *
    642644     * @param string $action The action being run.
     
    648650 * The main action used for handling theme-side GET requests.
    649651 *
    650  * @since BuddyPress (1.9.0)
     652 * @since 1.9.0
    651653 * @uses do_action()
    652654 */
     
    672674     * the scope of the 'action' without needing to check it in your function.
    673675     *
    674      * @since BuddyPress (1.9.0)
     676     * @since 1.9.0
    675677     */
    676678    do_action( 'bp_get_request_' . $action );
     
    681683     * Use this static action if you don't mind checking the 'action' yourself.
    682684     *
    683      * @since BuddyPress (1.9.0)
     685     * @since 1.9.0
    684686     *
    685687     * @param string $action The action being run.
Note: See TracChangeset for help on using the changeset viewer.