This plugin is intended for developer to send data to Simperium. Followings are use cases in which this plugin might come in handy:
How to use it
Once this plugin is installed and activated, you can send data to Simperium in following ways:
do_action( 'simperium_send_data', $bucket, $data )
or do_action( 'simperium_send_buffered_data', $bucket, $data )
. The first hook, will send the $data
immediately, while the later will send the data to buffer and will send all buffered data to Simperium at once after calling do_action( 'simperium_flush_buffer', $bucket )
. If $bucket
arg is provided, it only flushes buffered data that’s targetted to $bucket
.WP_Simperium::send_data( $bucket, $data )
or WP_Simperium::send_buffered_data( $bucket, $data )
. To flush buffer, you call WP_Simperium::flush_buffer( $bucket )
. Again, $bucket
arg is optional.The value of $data
MUST BE in key-value array structure as nested structure is not supported by Simperium.
Before using the action hooks or helper methods, you need to supply Simperium app credentials via simperium_config
filter, for example:
add_filter( 'simperium_config', function() { return array( 'app_id' => 'YOUR_APP_ID', 'api_key' => 'YOUR_API_KEY', ) } );
In addition to app_id
and api_key
you can pass username
and/or access_token
to the array config. If access_token
is omitted, the plugin will request access_token
from Simperium with provided username
(if exists) or get_bloginfo( 'admin_email' )
and store the info in option. Subsequent calls will read access_token
information from option, but can be bypassed by providing access_token
in array config. It’s preferred to supply your own access_token
or username
that hasn’t registered yet. Please keep in mind that token has 30 days life span. If you’re using access_token
that’s automatically retrieved by the plugin, you don’t need to worry as scheduled event will refresh the token per 29 days.
Sender Examples
I’ve created sender examples plugin that you can use as a starting point, though it will run without any customization. Currently it has following features:
Consumer Examples
I’m working to provide listener apps, written in PHP (stay tuned!), for now you can check Simperium examples and their awesome libraries.
Contributing