Ticket #5669: bsc.1.7.patch

includes/bp-example-activity.php

@@ -29 +29 @@
                 $bp->example->id,
                 'accepted_terms',
                 __( 'Accepted terms', 'bp-example' ),
-                'bp_example_format_accepted_terms_activity_action'
+                'bp_example_format_accepted_terms_activity_action',
+                __( 'Accepted terms', 'bp-example' ),
+                array( 'activity', 'member' )
         );
 
         bp_activity_set_action(
                 $bp->example->id,
                 'rejected_terms',
                 __( 'Rejected terms', 'bp-example' ),
-                'bp_example_format_rejected_terms_activity_action'
-        );
-
-        bp_activity_set_action(
-                $bp->example->id,
-                'new_high_five',
-                __( 'High fives', 'bp-example' ),
-                'bp_example_format_high_fives_activity_action'
+                'bp_example_format_rejected_terms_activity_action',
+                __( 'Rejected terms', 'bp-example' ),
+                array( 'activity', 'member' )
         );
 
         do_action( 'bp_example_register_activity_actions' );
@@ -79 +76 @@
 }
 
 function bp_example_format_high_fives_activity_action( $action, $activity ) {
-        if ( empty( $action ) || empty( $activity ) )
+        if (  empty( $activity ) || ( empty( $action ) && empty( $activity->id ) ) )
                 return false;
 
         $from_user_link = bp_core_get_userlink( $activity->user_id );
@@ -107 +104 @@
  */
 function bp_example_activity_options() {
 
+        if ( function_exists( 'bp_activity_show_filters' ) )
+                return;
+
         $bp_example_actions = buddypress()->activity->actions->example;
 
         foreach ( $bp_example_actions as $action ) {
@@ -177 +177 @@
 /**
  * Hooking bp_example_send_high_five to record an activity
  */
-function bp_example_record_high_five_activity( $to_user_id = 0, $from_user_id = 0 ) {
+function bp_example_record_high_five_activity( $post_id = 0, $post = null ) {
         // Bail if we don't have the needed inputs
-        if ( empty( $to_user_id ) || empty( $from_user_id ) )
+        if ( empty( $post ) )
                 return;
 
         /* Now record the new 'new_high_five' activity item */
-        $to_user_link = bp_core_get_userlink( $to_user_id );
-        $from_user_link = bp_core_get_userlink( $from_user_id );
+        $to_user_link = bp_core_get_userlink( bp_displayed_user_id() );
+        $from_user_link = bp_core_get_userlink( $post->post_author );
 
         bp_example_record_activity( array(
                 'type' => 'new_high_five',
                 'action' => apply_filters( 'bp_example_new_high_five_activity_action', sprintf( __( '%s high-fived %s!', 'bp-example' ), $from_user_link, $to_user_link ), $from_user_link, $to_user_link ),
-                'item_id' => $to_user_id,
+                'item_id' => bp_displayed_user_id(),
         ) );
 }
-// 9 priority is used to fire before the notifications
-add_action( 'bp_example_send_high_five', 'bp_example_record_high_five_activity', 9, 2 );
 
 /**
  * bp_example_record_activity()

includes/bp-example-loader.php

@@ -62 +62 @@
                  * components in the database.
                  */
                 $bp->active_components[ $this->id ] = '1';
-
-                /**
-                 * Hook the register_post_types() method. If you're using
-                 * custom post types to store data (which is recommended), you
-                 * will need to hook your function manually to 'init'.
-                 */
-                add_action( 'init', array( &$this, 'register_post_types' ) );
         }
 
         /**
@@ -417 +410 @@
          * @since 1.6
          * @see http://codex.wordpress.org/Function_Reference/register_post_type
          */
-        function register_post_types() {
+        function register_post_types( $post_types = array() ) {
                 // Set up some labels for the post type
                 $labels = array(
                         'name'     => __( 'High Fives', 'bp-example' ),
                         'singular' => __( 'High Five', 'bp-example' )
                 );
 
-                // Set up the argument array for register_post_type()
+                /**
+                 * Set up the argument array for register_post_type()
+                 * 
+                 * If buddypress arg is defined, you can set the activity recording
+                 * for your component where
+                 * - type : is your component's activity type
+                 * - description : is your component's activity description for the administration screen dropdown
+                 * - format_callback : is the format callback to use to build your component's activity action
+                 * - label : is your component's front end dropdown option label
+                 * 
+                 * - context : is an array of the contexts your component's dropdown option should show
+                 *              - activity      > the Activity directory page
+                 *              - member        > the user's activity profile pages
+                 *              - member_groups > the user's groups activity profile page
+                 *              - group         > the group's activity page (generally group's home page)
+                 *              
+                 *      Using context can avoid using the front-end dropdown hooks such as bp_activity_filter_options. Although, it's possible
+                 *      some themes didn't upgraded to BuddyPress 2.1 way of displaying new activity types in front end dropdowns.
+                 *      So you might check if bp_activity_show_filters() function exists to be sure of it, see bp_example_activity_options()
+                 *      for an example.
+                 *      
+                 * - track : whether to record or not an activity for your component
+                 * - publish_callback (optional) : your specific callback if you want to have more control on the way activities will be recorded
+                 * - unpublish_callback (optional) : your specific callback if you want to have more control on the way activities will be removed
+                 * - update_callback (optional) : your specific callback if you want to have more control on the way activities will be updated
+                 * - untrash_callback (optional) : your specific callback if you want to have more control on the way activities will be reverted
+                 * - remove_callback (optional) : your specific callback if you want to have more control on the way activities will be removed
+                 */ 
                 $args = array(
                         'label'    => __( 'High Fives', 'bp-example' ),
                         'labels'   => $labels,
                         'public'   => false,
                         'show_ui'  => true,
-                        'supports' => array( 'title' )
+                        'supports' => array( 'title' ),
+                        'buddypress' => array(
+                                'type'             => 'new_high_five',
+                                'description'      => __( 'High fives', 'bp-example' ),
+                                'format_callback'  => 'bp_example_format_high_fives_activity_action',
+                                'label'            => __( 'high fived', 'bp-example' ),
+                                'context'          => array( 'activity', 'member' ),
+                                'track'            => true,
+                                'publish_callback' => 'bp_example_record_high_five_activity'
+                        )
                 );
 
-                // Register the post type.
-                // Here we are using $this->id ('example') as the name of the
-                // post type. You may choose to use a different name for the
-                // post type; if you register more than one, you will have to
-                // declare more names.
-                register_post_type( $this->id, $args );
-
-                parent::register_post_types();
+                parent::register_post_types( array( $this->id => $args ) );
         }
 
         function register_taxonomies() {