Changeset 12008 for trunk/src/bp-templates/bp-nouveau/includes/activity/ajax.php

Timestamp:

04/28/2018 01:32:52 AM (8 years ago)

Author:

tw2113

Message:

add/touchup documentation to a lot of Nouveau actions and filters

File:

• trunk/src/bp-templates/bp-nouveau/includes/activity/ajax.php (modified) (2 diffs)

trunk/src/bp-templates/bp-nouveau/includes/activity/ajax.php

@@ -439 +439 @@
         wp_send_json_success( array_map( 'bp_nouveau_prepare_group_for_js', $groups['groups'] ) );
     } else {
+
+        /**
+         * Filters the response for custom activity objects.
+         *
+         * @since 3.0.0
+         *
+         * @param array $response Array of custom response objects to send to AJAX return.
+         * @param array $value    Activity object type from $_POST global.
+         */
         $response = apply_filters( 'bp_nouveau_get_activity_custom_objects', $response, $_POST['type'] );
     }
@@ -544 +553 @@
         'message'      => sprintf( __( 'Update posted <a href="%s" class="just-posted">View activity</a>', 'buddypress' ), esc_url( bp_activity_get_permalink( $activity_id ) ) ),
         'activity'     => $acivity,
+
+        /**
+         * Filters whether or not an AJAX post update is private.
+         *
+         * @since 3.0.0
+         *
+         * @param string/bool $is_private Privacy status for the update.
+         */
         'is_private'   => apply_filters( 'bp_nouveau_ajax_post_update_is_private', $is_private ),
         'is_directory' => bp_is_activity_directory(),