SelectPHP Channel Groups API Reference for Realtime Apps

These docs are for version 3.8.3 of the PHP SDK. To check out the docs for the latest version Click Here.
 

PubNub 4.0 for PHP is our latest and greatest! Please click here for our PubNub 4.0 for PHP docs and SDK.

PubNub 3.x for PHP will encounter End Of Life (EOL) Aug 1st, 2018. All users currently on 3.x should begin migrating to 4.x. The 3.x SDK will continue to work. We will no longer support it and if you run into an issue, we will request that you upgrade to the latest version before solving the issue.

If you have questions about the PubNub for PHP SDK, please contact us at support@pubnub.com.

Channel Groups allows PubNub developers to bundle thousands of channels into a group that can be identified by name. These Channel Groups can then be subscribed to, receiving data from the many backend-channels the channel group contains.

Learn more about our Channel Groups here


Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function adds a channel to a channel group.
Adding Channels is accomplished by using the following method(s) in the PHP SDK:
  1. ParameterTypeRequiredDescription
    channelString ArrayYesThe channel to add to the channel group.
    channelGroupStringYesThe channelGroup to add the channels to.
$channelGroup = "family";
$pubnub->channelGroupAddChannel($channelGroup, ["wife"]);
{
    "service" : "channel-registry",
    "status"  : 200,
    "error"   : false,
    "message" : "OK"
}

Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function lists all the channels of the channel group.
Listing Channels is accomplished by using the following method(s) in the PHP SDK:
  1. ParameterTypeRequiredDescription
    channelGroupStringYesChannel group to fetch the channels of.
$channelGroup = "family";
$pubnub->channelGroupListChannels($channelGroup);

{
	"status" : 200,
	"payload" : {
		"channels" : ["hi"], 
		"group" : "abcd"
	},
	"service" : "channel-registry",
	"error" : False
}

Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function removes the channels from the channel group.
Removing Channels is accomplished by using the following method(s) in the PHP SDK:
  1. ParameterTypeRequiredDescription
    channelGroupStringYesSpecifies a channelGroup to remove channels from
    channelsString ArrayYesChannels array to remove from a channel group
Removing channels :
$channelGroup = "family";
$pubnub->channelGroupRemoveChannel($channelGroup, ["son"]);

{
	"status" : 200,
	"message" : "OK",
	"service" : "channel-registry",
	"error" : False
}

Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function removes the channel group.
Deleting Channel Group is accomplished by using the following method(s) in the PHP SDK:
  1. ParameterTypeRequiredDescription
    channelGroupStringYesSpecifies channelGroup to remove.
Deleting Channel Group :
$channelGroup = "family";
$pubnub->channelGroupRemoveGroup($channelGroup);

{
	"status" : 200,
	"message" : "OK",
	"service" : "channel-registry",
	"error" : False
}