Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/03/2015 06:51:25 PM (9 years ago)
Author:
tw2113
Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:
1 edited

Legend:

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

    r9819 r9833  
    5353 *
    5454 * @param array $custom_menus The list of top-level BP menu items.
     55 *
    5556 * @return array $custom_menus List of top-level BP menu items, with Activity added
    5657 */
     
    139140 * @since BuddyPress (1.6.0)
    140141 *
    141  * @param string $value Will always be false unless another plugin filters it
    142  *        first.
    143  * @param string $option Screen option name.
     142 * @param string $value     Will always be false unless another plugin filters it first.
     143 * @param string $option    Screen option name.
    144144 * @param string $new_value Screen option form value.
     145 *
    145146 * @return string Option value. False to abandon update.
    146147 */
     
    162163 * @since BuddyPress (1.6.0)
    163164 *
     165 * @param array     $hidden Array of items to hide.
    164166 * @param WP_Screen $screen Screen identifier.
     167 *
    165168 * @return array Hidden Meta Boxes.
    166169 */
     
    194197 * @since BuddyPress (1.6.0)
    195198 *
    196  * @global object $bp BuddyPress global settings.
     199 * @global object                 $bp                    BuddyPress global settings.
    197200 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
    198201 */
     
    412415         * @since BuddyPress (1.6.0)
    413416         *
    414          * @param array  Array holding spam, not spam, deleted counts, error IDs.
    415          * @param string $redirect_to URL to redirect to.
     417         * @param array  $value        Array holding spam, not spam, deleted counts, error IDs.
     418         * @param string $redirect_to  URL to redirect to.
    416419         * @param array  $activity_ids Original array of activity IDs.
    417420         */
     
    640643     * @since BuddyPress (1.6.0)
    641644     *
    642      * @param array Array holding single activity object.
     645     * @param array $value Array holding single activity object that was passed by reference.
    643646     */
    644647    do_action_ref_array( 'bp_activity_admin_edit', array( &$activity ) ); ?>
     
    889892 * @since BuddyPress (1.6.0)
    890893 *
    891  * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list
    892  *         table.
    893  * @global string $plugin_page The current plugin page.
     894 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
     895 * @global string                 $plugin_page            The current plugin page.
    894896 */
    895897function bp_activity_admin_index() {
     
    12891291             *
    12901292             * @param string $url_base Current URL base for view.
    1291              * @param string $view Current view being displayed.
     1293             * @param string $view     Current view being displayed.
    12921294             */
    12931295            do_action( 'bp_activity_list_table_get_views', $url_base, $this->view ); ?>
     
    15221524         *
    15231525         * @param array $actions Array of available actions user could use.
    1524          * @param array $item Current item being added to page.
     1526         * @param array $item    Current item being added to page.
    15251527         */
    15261528        $actions = apply_filters( 'bp_activity_admin_comment_row_actions', array_filter( $actions ), $item );
     
    15741576         * @since BuddyPress (1.6.0)
    15751577         *
    1576          * @param array Array of default activity types.
    1577          * @param array $item Current item being displayed.
     1578         * @param array $value Array of default activity types.
     1579         * @param array $item  Current item being displayed.
    15781580         */
    15791581        if ( empty( $item['item_id'] ) || ! in_array( $item['type'], apply_filters( 'bp_activity_admin_root_activity_types', array( 'activity_comment' ), $item ) ) ) {
     
    16061608     *
    16071609     * @param int $activity_id Activity ID to retrieve User ID for.
     1610     *
    16081611     * @return int User ID of the activity item in question.
    16091612     */
     
    16461649     *
    16471650     * @param array $item An array version of the BP_Activity_Activity object.
     1651     *
    16481652     * @return bool
    16491653     */
     
    17101714     *
    17111715     * @param array $tree Source array.
     1716     *
    17121717     * @return array Flattened array.
    17131718     */
Note: See TracChangeset for help on using the changeset viewer.