Changeset 10375

Timestamp:

11/23/2015 05:51:55 AM (11 years ago)

Author:

tw2113

Message:

Misc docs fixes that were missed or added.

See #6396.

Location:

trunk/src/bp-activity

Files:

• bp-activity-actions.php (modified) (1 diff)
• bp-activity-admin.php (modified) (3 diffs)
• bp-activity-akismet.php (modified) (1 diff)
• bp-activity-filters.php (modified) (2 diffs)
• bp-activity-functions.php (modified) (1 diff)
• classes/class-bp-activity-activity.php (modified) (1 diff)

trunk/src/bp-activity/bp-activity-actions.php

@@ -106 +106 @@
          * @since 1.2.2
          *
-         * @param array Array with url to redirect to and activity related to the redirect.
+         * @param array $value Array with url to redirect to and activity related to the redirect.
          */
         if ( ! $redirect = apply_filters_ref_array( 'bp_activity_permalink_redirect_url', array( $redirect, &$activity ) ) ) {

trunk/src/bp-activity/bp-activity-admin.php

@@ -361 +361 @@
                 foreach ( $activity_ids as $activity_id ) {
                         // @todo: Check the permissions on each
-                        //if ( ! current_user_can( 'bp_edit_activity', $activity_id ) )
+                        // if ( ! current_user_can( 'bp_edit_activity', $activity_id ) )
                         // continue;
-
                         // Get the activity from the database.
                         $activity = new BP_Activity_Activity( $activity_id );
@@ -566 +565 @@
                  * @since 1.6.0
                  *
-                 * @param array Array holding activity object and ID that holds error.
+                 * @param array $value Array holding activity object and ID that holds error.
                  */
                 do_action_ref_array( 'bp_activity_admin_edit_after', array( &$activity, $error ) );
@@ -1651 +1650 @@
 
                 <?php
-                // Activity permalink
+                // Activity permalink.
                 $activity_permalink = '';
                 if ( ! $item['is_spam'] ) {

trunk/src/bp-activity/bp-activity-akismet.php

@@ -255 +255 @@
                  * @since 1.6.0
                  *
-                 * @param array Array of default activity types for Akismet to check.
+                 * @param array $value Array of default activity types for Akismet to check.
                  */
                 return apply_filters( 'bp_akismet_get_activity_types', array( 'activity_comment', 'activity_update' ) );

trunk/src/bp-activity/bp-activity-filters.php

@@ -10 +10 @@
 defined( 'ABSPATH' ) || exit;
 
-/** Filters *******************************************************************/
+/* Filters *******************************************************************/
 
 // Apply WordPress defined filters.
@@ -99 +99 @@
 add_filter( 'bp_get_total_mention_count_for_user',  'bp_core_number_format' );
 
-/** Actions *******************************************************************/
+/* Actions *******************************************************************/
 
 // At-name filter.

trunk/src/bp-activity/bp-activity-functions.php

@@ -1427 +1427 @@
 
         $r = bp_parse_args( $args, array(
-                'max'               => false,        // Maximum number of results to return
+                'max'               => false,        // Maximum number of results to return.
                 'fields'            => 'all',
-                'page'              => 1,            // page 1 without a per_page will result in no pagination.
+                'page'              => 1,            // Page 1 without a per_page will result in no pagination.
                 'per_page'          => false,        // results per page
                 'sort'              => 'DESC',       // sort ASC or DESC
-                'display_comments'  => false,        // false for no comments. 'stream' for within stream display, 'threaded' for below each activity item
+                'display_comments'  => false,        // False for no comments. 'stream' for within stream display, 'threaded' for below each activity item.
 
                 'search_terms'      => false,        // Pass search terms as a string
                 'meta_query'        => false,        // Filter by activity meta. See WP_Meta_Query for format
-                'date_query'        => false,        // Filter by date. See first parameter of WP_Date_Query for format
+                'date_query'        => false,        // Filter by date. See first parameter of WP_Date_Query for format.
                 'filter_query'      => false,
                 'show_hidden'       => false,        // Show activity items that are hidden site-wide?

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -480 +480 @@
                  * @since 1.6.0
                  *
-                 * @param array Array of indexes in preferred order.
+                 * @param array $value Array of indexes in preferred order.
                  */
                 $indexes = apply_filters( 'bp_activity_preferred_index_order', array( 'user_id', 'item_id', 'secondary_item_id', 'date_recorded', 'component', 'type', 'hide_sitewide', 'is_spam' ) );