Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/08/2013 08:58:22 PM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs for bp-activity-screens.php

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-activity/bp-activity-screens.php

    r7386 r7402  
    22
    33/**
    4  * BuddyPress Activity Screens
     4 * BuddyPress Activity Screens.
     5 *
     6 * The functions in this file detect, with each page load, whether an Activity
     7 * component page is being requested. If so, it parses any necessary data from
     8 * the URL, and tells BuddyPress to load the appropriate template.
    59 *
    610 * @package BuddyPress
     
    1216
    1317/**
    14  * Activity screen index
     18 * Load the Activity directory.
    1519 *
    1620 * @since BuddyPress (1.5)
     
    2024 * @uses bp_current_action()
    2125 * @uses bp_update_is_directory()
    22  * @uses do_action() To call the 'bp_activity_screen_index' hook
    23  * @uses bp_core_load_template()
    24  * @uses apply_filters() To call the 'bp_activity_screen_index' hook
     26 * @uses do_action() To call the 'bp_activity_screen_index' hook.
     27 * @uses bp_core_load_template()
     28 * @uses apply_filters() To call the 'bp_activity_screen_index' hook.
    2529 */
    2630function bp_activity_screen_index() {
     
    3640
    3741/**
    38  * Activity screen 'my activity' index
     42 * Load the 'My Activity' page.
    3943 *
    4044 * @since BuddyPress (1.0)
    4145 *
    42  * @uses do_action() To call the 'bp_activity_screen_my_activity' hook
    43  * @uses bp_core_load_template()
    44  * @uses apply_filters() To call the 'bp_activity_template_my_activity' hook
     46 * @uses do_action() To call the 'bp_activity_screen_my_activity' hook.
     47 * @uses bp_core_load_template()
     48 * @uses apply_filters() To call the 'bp_activity_template_my_activity' hook.
    4549 */
    4650function bp_activity_screen_my_activity() {
     
    5054
    5155/**
    52  * Activity screen 'friends' index
     56 * Load the 'My Friends' activity page.
    5357 *
    5458 * @since BuddyPress (1.0)
     
    5761 * @uses bp_update_is_item_admin()
    5862 * @uses bp_current_user_can()
    59  * @uses do_action() To call the 'bp_activity_screen_friends' hook
    60  * @uses bp_core_load_template()
    61  * @uses apply_filters() To call the 'bp_activity_template_friends_activity' hook
     63 * @uses do_action() To call the 'bp_activity_screen_friends' hook.
     64 * @uses bp_core_load_template()
     65 * @uses apply_filters() To call the 'bp_activity_template_friends_activity' hook.
    6266 */
    6367function bp_activity_screen_friends() {
     
    7175
    7276/**
    73  * Activity screen 'groups' index
     77 * Load the 'My Groups' activity page.
    7478 *
    7579 * @since BuddyPress (1.2)
     
    9296
    9397/**
    94  * Activity screen 'favorites' index
     98 * Load the 'Favorites' activity page.
    9599 *
    96100 * @since BuddyPress (1.2)
     
    109113
    110114/**
    111  * Activity screen 'mentions' index
     115 * Load the 'Mentions' activity page.
    112116 *
    113117 * @since BuddyPress (1.2)
     
    126130
    127131/**
    128  * Removes activity notifications from the notification menu when a user clicks on them and
    129  * is taken to a specific screen.
     132 * Remove activity notifications when a user clicks on them.
    130133 *
    131134 * @since BuddyPress (1.5)
     
    144147
    145148/**
    146  * Reset the logged-in user's new mentions data when he visits his mentions screen
     149 * Reset the logged-in user's new mentions data when he visits his mentions screen.
    147150 *
    148151 * @since BuddyPress (1.5)
     
    159162
    160163/**
    161  * Reset the logged-in user's new mentions data when he visits his mentions screen
     164 * Load the page for a single activity item.
    162165 *
    163166 * @since BuddyPress (1.2)
     
    256259
    257260/**
    258  * Add activity notifications settings to the notifications settings page
     261 * Add activity notifications settings to the notifications settings page.
    259262 *
    260263 * @since BuddyPress (1.2)
     
    262265 * @uses bp_get_user_meta()
    263266 * @uses bp_core_get_username()
    264  * @uses do_action() To call the 'bp_activity_screen_notification_settings' hook
     267 * @uses do_action() To call the 'bp_activity_screen_notification_settings' hook.
    265268 */
    266269function bp_activity_screen_notification_settings() {
     
    316319
    317320/**
    318  * The main theme compat class for BuddyPress Activity
     321 * The main theme compat class for BuddyPress Activity.
    319322 *
    320323 * This class sets up the necessary theme compatability actions to safely output
     
    326329
    327330    /**
    328      * Setup the activity component theme compatibility
     331     * Set up the activity component theme compatibility.
    329332     *
    330333     * @since BuddyPress (1.7)
     
    335338
    336339    /**
    337      * Are we looking at something that needs activity theme compatability?
     340     * Set up the theme compatibility hooks, if we're looking at an activity page.
    338341     *
    339342     * @since BuddyPress (1.7)
     
    372375     * @since BuddyPress (1.8)
    373376     *
    374      * @param string $templates The templates from bp_get_theme_compat_templates()
     377     * @param string $templates The templates from bp_get_theme_compat_templates().
    375378     * @return array $templates Array of custom templates to look for.
    376379     */
     
    389392
    390393    /**
    391      * Update the global $post with directory data
     394     * Update the global $post with directory data.
    392395     *
    393396     * @since BuddyPress (1.7)
     
    408411
    409412    /**
    410      * Filter the_content with the groups index template part
     413     * Filter the_content with the groups index template part.
    411414     *
    412415     * @since BuddyPress (1.7)
     
    425428     * @since BuddyPress (1.8)
    426429     *
    427      * @param string $templates The templates from bp_get_theme_compat_templates()
     430     * @param string $templates The templates from bp_get_theme_compat_templates().
    428431     * @return array $templates Array of custom templates to look for.
    429432     */
     
    442445
    443446    /**
    444      * Update the global $post with the displayed user's data
     447     * Update the global $post with the displayed user's data.
    445448     *
    446449     * @since BuddyPress (1.7)
     
    461464
    462465    /**
    463      * Filter the_content with the members' activity permalink template part
     466     * Filter the_content with the members' activity permalink template part.
    464467     *
    465468     * @since BuddyPress (1.7)
Note: See TracChangeset for help on using the changeset viewer.