Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

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

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Screens.
     
    1817 * Load the Activity directory.
    1918 *
    20  * @since BuddyPress (1.5.0)
     19 * @since 1.5.0
    2120 *
    2221 * @uses bp_displayed_user_id()
     
    3534         * Fires right before the loading of the Activity directory screen template file.
    3635         *
    37          * @since BuddyPress (1.5.0)
     36         * @since 1.5.0
    3837         */
    3938        do_action( 'bp_activity_screen_index' );
     
    4241         * Filters the template to load for the Activity directory screen.
    4342         *
    44          * @since BuddyPress (1.5.0)
     43         * @since 1.5.0
    4544         *
    4645         * @param string $template Path to the activity template to load.
     
    5453 * Load the 'My Activity' page.
    5554 *
    56  * @since BuddyPress (1.0.0)
     55 * @since 1.0.0
    5756 *
    5857 * @uses do_action() To call the 'bp_activity_screen_my_activity' hook.
     
    6564     * Fires right before the loading of the "My Activity" screen template file.
    6665     *
    67      * @since BuddyPress (1.0.0)
     66     * @since 1.0.0
    6867     */
    6968    do_action( 'bp_activity_screen_my_activity' );
     
    7271     * Filters the template to load for the "My Activity" screen.
    7372     *
    74      * @since BuddyPress (1.0.0)
     73     * @since 1.0.0
    7574     *
    7675     * @param string $template Path to the activity template to load.
     
    8281 * Load the 'My Friends' activity page.
    8382 *
    84  * @since BuddyPress (1.0.0)
     83 * @since 1.0.0
    8584 *
    8685 * @uses bp_is_active()
     
    10099     * Fires right before the loading of the "My Friends" screen template file.
    101100     *
    102      * @since BuddyPress (1.2.0)
     101     * @since 1.2.0
    103102     */
    104103    do_action( 'bp_activity_screen_friends' );
     
    107106     * Filters the template to load for the "My Friends" screen.
    108107     *
    109      * @since BuddyPress (1.0.0)
     108     * @since 1.0.0
    110109     *
    111110     * @param string $template Path to the activity template to load.
     
    117116 * Load the 'My Groups' activity page.
    118117 *
    119  * @since BuddyPress (1.2.0)
     118 * @since 1.2.0
    120119 *
    121120 * @uses bp_is_active()
     
    135134     * Fires right before the loading of the "My Groups" screen template file.
    136135     *
    137      * @since BuddyPress (1.2.0)
     136     * @since 1.2.0
    138137     */
    139138    do_action( 'bp_activity_screen_groups' );
     
    142141     * Filters the template to load for the "My Groups" screen.
    143142     *
    144      * @since BuddyPress (1.2.0)
     143     * @since 1.2.0
    145144     *
    146145     * @param string $template Path to the activity template to load.
     
    152151 * Load the 'Favorites' activity page.
    153152 *
    154  * @since BuddyPress (1.2.0)
     153 * @since 1.2.0
    155154 *
    156155 * @uses bp_update_is_item_admin()
     
    166165     * Fires right before the loading of the "Favorites" screen template file.
    167166     *
    168      * @since BuddyPress (1.2.0)
     167     * @since 1.2.0
    169168     */
    170169    do_action( 'bp_activity_screen_favorites' );
     
    173172     * Filters the template to load for the "Favorites" screen.
    174173     *
    175      * @since BuddyPress (1.2.0)
     174     * @since 1.2.0
    176175     *
    177176     * @param string $template Path to the activity template to load.
     
    183182 * Load the 'Mentions' activity page.
    184183 *
    185  * @since BuddyPress (1.2.0)
     184 * @since 1.2.0
    186185 *
    187186 * @uses bp_update_is_item_admin()
     
    197196     * Fires right before the loading of the "Mentions" screen template file.
    198197     *
    199      * @since BuddyPress (1.2.0)
     198     * @since 1.2.0
    200199     */
    201200    do_action( 'bp_activity_screen_mentions' );
     
    204203     * Filters the template to load for the "Mentions" screen.
    205204     *
    206      * @since BuddyPress (1.2.0)
     205     * @since 1.2.0
    207206     *
    208207     * @param string $template Path to the activity template to load.
     
    214213 * Reset the logged-in user's new mentions data when he visits his mentions screen.
    215214 *
    216  * @since BuddyPress (1.5.0)
     215 * @since 1.5.0
    217216 *
    218217 * @uses bp_is_my_profile()
     
    229228 * Load the page for a single activity item.
    230229 *
    231  * @since BuddyPress (1.2.0)
     230 * @since 1.2.0
    232231 *
    233232 * @uses bp_is_activity_component()
     
    303302     * Filters the access permission for a single activity view.
    304303     *
    305      * @since BuddyPress (1.2.0)
     304     * @since 1.2.0
    306305     *
    307306     * @param array $access Array holding the current $has_access value and current activity item instance.
     
    312311     * Fires before the loading of a single activity template file.
    313312     *
    314      * @since BuddyPress (1.2.0)
     313     * @since 1.2.0
    315314     *
    316315     * @param BP_Activity_Activity $activity   Object representing the current activity item being displayed.
     
    342341     * Filters the template to load for a single activity screen.
    343342     *
    344      * @since BuddyPress (1.0.0)
     343     * @since 1.0.0
    345344     *
    346345     * @param string $template Path to the activity template to load.
     
    353352 * Add activity notifications settings to the notifications settings page.
    354353 *
    355  * @since BuddyPress (1.2.0)
     354 * @since 1.2.0
    356355 *
    357356 * @uses bp_get_user_meta()
     
    405404             * Fires inside the closing </tbody> tag for activity screen notification settings.
    406405             *
    407              * @since BuddyPress (1.2.0)
     406             * @since 1.2.0
    408407             */
    409408            do_action( 'bp_activity_screen_notification_settings' ) ?>
     
    423422 * activity template parts to the_title and the_content areas of a theme.
    424423 *
    425  * @since BuddyPress (1.7.0)
     424 * @since 1.7.0
    426425 */
    427426class BP_Activity_Theme_Compat {
     
    430429     * Set up the activity component theme compatibility.
    431430     *
    432      * @since BuddyPress (1.7.0)
     431     * @since 1.7.0
    433432     */
    434433    public function __construct() {
     
    439438     * Set up the theme compatibility hooks, if we're looking at an activity page.
    440439     *
    441      * @since BuddyPress (1.7.0)
     440     * @since 1.7.0
    442441     */
    443442    public function is_activity() {
     
    473472     * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    474473     *
    475      * @since BuddyPress (1.8.0)
     474     * @since 1.8.0
    476475     *
    477476     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    484483         * Filters the template hierarchy for the activity directory page.
    485484         *
    486          * @since BuddyPress (1.8.0)
     485         * @since 1.8.0
    487486         *
    488487         * @param array $index-directory Array holding template names to be merged into template list.
     
    502501     * Update the global $post with directory data.
    503502     *
    504      * @since BuddyPress (1.7.0)
     503     * @since 1.7.0
    505504     */
    506505    public function directory_dummy_post() {
     
    521520     * Filter the_content with the groups index template part.
    522521     *
    523      * @since BuddyPress (1.7.0)
     522     * @since 1.7.0
    524523     */
    525524    public function directory_content() {
     
    534533     * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    535534     *
    536      * @since BuddyPress (1.8.0)
     535     * @since 1.8.0
    537536     *
    538537     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    545544         * Filters the template hierarchy for the activity permalink pages.
    546545         *
    547          * @since BuddyPress (1.8.0)
     546         * @since 1.8.0
    548547         *
    549548         * @param array $index Array holding template names to be merged into template list.
     
    563562     * Update the global $post with the displayed user's data.
    564563     *
    565      * @since BuddyPress (1.7.0)
     564     * @since 1.7.0
    566565     */
    567566    public function single_dummy_post() {
     
    582581     * Filter the_content with the members' activity permalink template part.
    583582     *
    584      * @since BuddyPress (1.7.0)
     583     * @since 1.7.0
    585584     */
    586585    public function single_dummy_content() {
Note: See TracChangeset for help on using the changeset viewer.