Skip to:
Content

BuddyPress.org

Changeset 7390


Ignore:
Timestamp:
10/06/2013 03:05:32 PM (11 years ago)
Author:
boonebgorges
Message:

Inline doc improvements for bp-activity-actions.php

See #5022

File:
1 edited

Legend:

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

    r7336 r7390  
    1414
    1515/**
    16  * Allow core components and dependent plugins to register activity actions
     16 * Allow core components and dependent plugins to register activity actions.
    1717 *
    1818 * @since BuddyPress (1.2)
     
    2626
    2727/**
    28  * Allow core components and dependent plugins to register activity actions
     28 * Catch and route requests for single activity item permalinks.
    2929 *
    3030 * @since BuddyPress (1.2)
     
    3939 * @uses groups_get_group()
    4040 * @uses bp_get_group_permalink()
    41  * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook
     41 * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook.
    4242 * @uses bp_core_redirect()
    4343 * @uses bp_get_root_domain()
    4444 *
    45  * @return bool False on failure
     45 * @return bool False on failure.
    4646 */
    4747function bp_activity_action_permalink_router() {
     
    125125 * @uses bp_core_redirect()
    126126 *
    127  * @return bool False on failure
     127 * @return bool False on failure.
    128128 */
    129129function bp_activity_action_delete_activity( $activity_id = 0 ) {
     
    170170
    171171/**
    172  * Mark specific activity item as spam and redirect to previous page
     172 * Mark specific activity item as spam and redirect to previous page.
     173 *
     174 * @since BuddyPress (1.6)
    173175 *
    174176 * @global object $bp BuddyPress global settings
    175177 * @param int $activity_id Activity id to be deleted. Defaults to 0.
    176  * @return bool False on failure
    177  * @since BuddyPress (1.6)
     178 * @return bool False on failure.
    178179 */
    179180function bp_activity_action_spam_activity( $activity_id = 0 ) {
     
    242243 * @uses apply_filters() To call 'bp_activity_custom_update' hook.
    243244 *
    244  * @return bool False on failure
     245 * @return bool False on failure.
    245246 */
    246247function bp_activity_action_post_update() {
     
    306307 * @uses wp_get_referer()
    307308 *
    308  * @return bool False on failure
     309 * @return bool False on failure.
    309310 */
    310311function bp_activity_action_post_comment() {
     
    354355 * @uses wp_get_referer()
    355356 *
    356  * @return bool False on failure
     357 * @return bool False on failure.
    357358 */
    358359function bp_activity_action_mark_favorite() {
     
    388389 * @uses wp_get_referer()
    389390 *
    390  * @return bool False on failure
     391 * @return bool False on failure.
    391392 */
    392393function bp_activity_action_remove_favorite() {
     
    408409
    409410/**
    410  * Load the sitewide feed.
     411 * Load the sitewide activity feed.
    411412 *
    412413 * @since BuddyPress (1.0)
    413414 *
    414415 * @global object $bp BuddyPress global settings
    415  * @global object $wp_query
    416416 * @uses bp_is_activity_component()
    417417 * @uses bp_is_current_action()
     
    419419 * @uses status_header()
    420420 *
    421  * @return bool False on failure
     421 * @return bool False on failure.
    422422 */
    423423function bp_activity_action_sitewide_feed() {
     
    442442
    443443/**
    444  * Load a user's personal feed.
     444 * Load a user's personal activity feed.
    445445 *
    446446 * @since BuddyPress (1.0)
    447447 *
    448  * @global object $wp_query
    449448 * @uses bp_is_user_activity()
    450449 * @uses bp_is_current_action()
    451450 * @uses status_header()
    452451 *
    453  * @return bool False on failure
     452 * @return bool False on failure.
    454453 */
    455454function bp_activity_action_personal_feed() {
     
    473472
    474473/**
    475  * Load a user's friends feed.
     474 * Load a user's friends' activity feed.
    476475 *
    477476 * @since BuddyPress (1.0)
    478477 *
    479  * @global object $wp_query
    480478 * @uses bp_is_active()
    481479 * @uses bp_is_user_activity()
     
    485483 * @uses status_header()
    486484 *
    487  * @return bool False on failure
     485 * @return bool False on failure.
    488486 */
    489487function bp_activity_action_friends_feed() {
     
    507505
    508506/**
    509  * Load a user's my groups feed.
    510  *
    511  * @since BuddyPress (1.2)
    512  *
    513  * @global object $wp_query
     507 * Load the activity feed for a user's groups.
     508 *
     509 * @since BuddyPress (1.2)
     510 *
    514511 * @uses bp_is_active()
    515512 * @uses bp_is_user_activity()
     
    519516 * @uses status_header()
    520517 *
    521  * @return bool False on failure
     518 * @return bool False on failure.
    522519 */
    523520function bp_activity_action_my_groups_feed() {
     
    553550 * @since BuddyPress (1.2)
    554551 *
    555  * @global object $wp_query
    556552 * @uses bp_is_user_activity()
    557553 * @uses bp_is_current_action()
     
    559555 * @uses status_header()
    560556 *
    561  * @return bool False on failure
     557 * @return bool False on failure.
    562558 */
    563559function bp_activity_action_mentions_feed() {
     
    591587 * @since BuddyPress (1.2)
    592588 *
    593  * @global object $wp_query
    594589 * @uses bp_is_user_activity()
    595590 * @uses bp_is_current_action()
     
    597592 * @uses status_header()
    598593 *
    599  * @return bool False on failure
     594 * @return bool False on failure.
    600595 */
    601596function bp_activity_action_favorites_feed() {
     
    623618
    624619/**
    625  * Loads Akismet
     620 * Loads Akismet filtering for activity.
     621 *
     622 * @since BuddyPress (1.6)
    626623 *
    627624 * @global object $bp BuddyPress global settings
    628  * @since BuddyPress (1.6)
    629625 */
    630626function bp_activity_setup_akismet() {
Note: See TracChangeset for help on using the changeset viewer.