Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/06/2011 12:30:01 PM (15 years ago)
Author:
boonebgorges
Message:

Adds PHPDoc throughout the activity component. References #2345. Turbo props cnorris23

File:
1 edited

Legend:

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

    r5072 r5109  
    11<?php
    2 /*******************************************************************************
     2
     3/**
    34 * Action functions are exactly the same as screen functions, however they do
    45 * not have a template screen associated with them. Usually they will send the
    56 * user back to the default screen after execution.
     7 *
     8 * @package BuddyPress
     9 * @subpackage ActivityActions
    610 */
    711
     
    913if ( !defined( 'ABSPATH' ) ) exit;
    1014
    11 // Allow core components and dependent plugins to register activity actions
     15/**
     16 * Allow core components and dependent plugins to register activity actions
     17 *
     18 * @since 1.2.0
     19 *
     20 * @uses do_action() To call 'bp_register_activity_actions' hook.
     21 */
    1222function bp_register_activity_actions() {
    1323    do_action( 'bp_register_activity_actions' );
     
    1525add_action( 'bp_init', 'bp_register_activity_actions', 8 );
    1626
     27/**
     28 * Allow core components and dependent plugins to register activity actions
     29 *
     30 * @since 1.2.0
     31 *
     32 * @global object $bp BuddyPress global settings
     33 * @uses bp_is_activity_component()
     34 * @uses bp_is_current_action()
     35 * @uses bp_action_variable()
     36 * @uses bp_activity_get_specific()
     37 * @uses bp_is_active()
     38 * @uses bp_core_get_user_domain()
     39 * @uses groups_get_group()
     40 * @uses bp_get_group_permalink()
     41 * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook
     42 * @uses bp_core_redirect()
     43 * @uses bp_get_root_domain()
     44 *
     45 * @return bool False on failure
     46 */
    1747function bp_activity_action_permalink_router() {
    1848    global $bp;
     
    72102
    73103/**
    74  * bp_activity_action_delete_activity()
    75  *
    76104 * Delete specific activity item and redirect to previous page.
    77105 *
    78  * @global object $bp
    79  * @since 1.1
     106 * @since 1.1.0
     107 *
     108 * @param int $activity_id Activity id to be deleted. Defaults to 0.
     109 *
     110 * @global object $bp BuddyPress global settings
     111 * @uses bp_is_activity_component()
     112 * @uses bp_is_current_action()
     113 * @uses bp_action_variable()
     114 * @uses check_admin_referer()
     115 * @uses bp_activity_user_can_delete()
     116 * @uses do_action() Calls 'bp_activity_before_action_delete_activity' hook to allow actions to be taken before the activity is deleted.
     117 * @uses bp_activity_delete()
     118 * @uses bp_core_add_message()
    80119 * @uses do_action() Calls 'bp_activity_action_delete_activity' hook to allow actions to be taken after the activity is deleted.
    81  * @uses do_action() Calls 'bp_activity_before_action_delete_activity' hook to allow actions to be taken before the activity is deleted.
     120 * @uses bp_core_redirect()
     121 *
     122 * @return bool False on failure
    82123 */
    83124function bp_activity_action_delete_activity( $activity_id = 0 ) {
     
    124165add_action( 'bp_actions', 'bp_activity_action_delete_activity' );
    125166
     167/**
     168 * Post user/group activity update.
     169 *
     170 * @since 1.2.0
     171 *
     172 * @global object $bp BuddyPress global settings
     173 * @uses is_user_logged_in()
     174 * @uses bp_is_activity_component()
     175 * @uses bp_is_current_action()
     176 * @uses check_admin_referer()
     177 * @uses apply_filters() To call 'bp_activity_post_update_content' hook.
     178 * @uses apply_filters() To call 'bp_activity_post_update_object' hook.
     179 * @uses apply_filters() To call 'bp_activity_post_update_item_id' hook.
     180 * @uses bp_core_add_message()
     181 * @uses bp_core_redirect()
     182 * @uses bp_activity_post_update()
     183 * @uses groups_post_update()
     184 * @uses bp_core_redirect()
     185 * @uses apply_filters() To call 'bp_activity_custom_update' hook.
     186 *
     187 * @return bool False on failure
     188 */
    126189function bp_activity_action_post_update() {
    127190    global $bp;
     
    171234add_action( 'bp_actions', 'bp_activity_action_post_update' );
    172235
     236/**
     237 * Post new activity comment.
     238 *
     239 * @since 1.2.0
     240 *
     241 * @global object $bp BuddyPress global settings
     242 * @uses is_user_logged_in()
     243 * @uses bp_is_activity_component()
     244 * @uses bp_is_current_action()
     245 * @uses check_admin_referer()
     246 * @uses apply_filters() To call 'bp_activity_post_comment_activity_id' hook.
     247 * @uses apply_filters() To call 'bp_activity_post_comment_content' hook.
     248 * @uses bp_core_add_message()
     249 * @uses bp_core_redirect()
     250 * @uses bp_activity_new_comment()
     251 * @uses wp_get_referer()
     252 *
     253 * @return bool False on failure
     254 */
    173255function bp_activity_action_post_comment() {
    174256    global $bp;
     
    203285add_action( 'bp_actions', 'bp_activity_action_post_comment' );
    204286
     287/**
     288 * Mark activity as favorite.
     289 *
     290 * @since 1.2.0
     291 *
     292 * @global object $bp BuddyPress global settings
     293 * @uses is_user_logged_in()
     294 * @uses bp_is_activity_component()
     295 * @uses bp_is_current_action()
     296 * @uses check_admin_referer()
     297 * @uses bp_activity_add_user_favorite()
     298 * @uses bp_action_variable()
     299 * @uses bp_core_add_message()
     300 * @uses bp_core_redirect()
     301 * @uses wp_get_referer()
     302 *
     303 * @return bool False on failure
     304 */
    205305function bp_activity_action_mark_favorite() {
    206306    global $bp;
     
    221321add_action( 'bp_actions', 'bp_activity_action_mark_favorite' );
    222322
     323/**
     324 * Remove activity from favorites.
     325 *
     326 * @since 1.2.0
     327 *
     328 * @global object $bp BuddyPress global settings
     329 * @uses is_user_logged_in()
     330 * @uses bp_is_activity_component()
     331 * @uses bp_is_current_action()
     332 * @uses check_admin_referer()
     333 * @uses bp_activity_remove_user_favorite()
     334 * @uses bp_action_variable()
     335 * @uses bp_core_add_message()
     336 * @uses bp_core_redirect()
     337 * @uses wp_get_referer()
     338 *
     339 * @return bool False on failure
     340 */
    223341function bp_activity_action_remove_favorite() {
    224342    global $bp;
     
    239357add_action( 'bp_actions', 'bp_activity_action_remove_favorite' );
    240358
     359/**
     360 * Load the sitewide feed.
     361 *
     362 * @since 1.0.0
     363 *
     364 * @global object $bp BuddyPress global settings
     365 * @global object $wp_query
     366 * @uses bp_is_activity_component()
     367 * @uses bp_is_current_action()
     368 * @uses bp_is_user()
     369 * @uses status_header()
     370 *
     371 * @return bool False on failure
     372 */
    241373function bp_activity_action_sitewide_feed() {
    242374    global $bp, $wp_query;
     
    253385add_action( 'bp_actions', 'bp_activity_action_sitewide_feed' );
    254386
     387/**
     388 * Load a user's personal feed.
     389 *
     390 * @since 1.0.0
     391 *
     392 * @global object $bp BuddyPress global settings
     393 * @global object $wp_query
     394 * @uses bp_is_user_activity()
     395 * @uses bp_is_current_action()
     396 * @uses status_header()
     397 *
     398 * @return bool False on failure
     399 */
    255400function bp_activity_action_personal_feed() {
    256401    global $bp, $wp_query;
     
    267412add_action( 'bp_actions', 'bp_activity_action_personal_feed' );
    268413
     414/**
     415 * Load a user's friends feed.
     416 *
     417 * @since 1.0.0
     418 *
     419 * @global object $bp BuddyPress global settings
     420 * @global object $wp_query
     421 * @uses bp_is_active()
     422 * @uses bp_is_user_activity()
     423 * @uses bp_is_current_action()
     424 * @uses bp_get_friends_slug()
     425 * @uses bp_is_action_variable()
     426 * @uses status_header()
     427 *
     428 * @return bool False on failure
     429 */
    269430function bp_activity_action_friends_feed() {
    270431    global $bp, $wp_query;
     
    281442add_action( 'bp_actions', 'bp_activity_action_friends_feed' );
    282443
     444/**
     445 * Load a user's my groups feed.
     446 *
     447 * @since 1.2.0
     448 *
     449 * @global object $bp BuddyPress global settings
     450 * @global object $wp_query
     451 * @uses bp_is_active()
     452 * @uses bp_is_user_activity()
     453 * @uses bp_is_current_action()
     454 * @uses bp_get_groups_slug()
     455 * @uses bp_is_action_variable()
     456 * @uses status_header()
     457 *
     458 * @return bool False on failure
     459 */
    283460function bp_activity_action_my_groups_feed() {
    284461    global $bp, $wp_query;
     
    295472add_action( 'bp_actions', 'bp_activity_action_my_groups_feed' );
    296473
     474/**
     475 * Load a user's @mentions feed.
     476 *
     477 * @since 1.2.0
     478 *
     479 * @global object $bp BuddyPress global settings
     480 * @global object $wp_query
     481 * @uses bp_is_user_activity()
     482 * @uses bp_is_current_action()
     483 * @uses bp_is_action_variable()
     484 * @uses status_header()
     485 *
     486 * @return bool False on failure
     487 */
    297488function bp_activity_action_mentions_feed() {
    298489    global $bp, $wp_query;
     
    309500add_action( 'bp_actions', 'bp_activity_action_mentions_feed' );
    310501
     502/**
     503 * Load a user's favorites feed.
     504 *
     505 * @since 1.2.0
     506 *
     507 * @global object $bp BuddyPress global settings
     508 * @global object $wp_query
     509 * @uses bp_is_user_activity()
     510 * @uses bp_is_current_action()
     511 * @uses bp_is_action_variable()
     512 * @uses status_header()
     513 *
     514 * @return bool False on failure
     515 */
    311516function bp_activity_action_favorites_feed() {
    312517    global $bp, $wp_query;
Note: See TracChangeset for help on using the changeset viewer.