PHP Class MC4WP_MailChimp_List

Represents a list in MailChimp
Show file Open project: dannyvankooten/mailchimp-for-wordpress Class Usage Examples

Public Properties

Property Type Description
$id ID of this list for API usage
$interest_categories MC4WP_MailChimp_Interest_Category[]
$merge_fields MC4WP_MailChimp_Merge_Field[]
$name Name of this list
$subscriber_count Number of subscribers on this list
$web_id Web ID of this list in MailChimp.com

Public Methods

Method Description
__construct ( string $id, string $name, string $web_id = '' )
__get ( string $name ) : mixed
get_field_by_tag ( string $tag ) : MC4WP_MailChimp_Merge_Field
get_field_name_by_tag ( string $tag ) : string
get_interest_category ( string $category_id ) : MC4WP_MailChimp_Interest_Category Get the interest grouping object for a given list.
get_interest_category_by_interest_id ( string $interest_id ) : MC4WP_MailChimp_Interest_Category
get_interest_category_name ( string $category_id ) : string Get the name of an interest category by its ID
get_web_url ( ) : string Get link to this list in MailChimp

Method Details

__construct() public method

public __construct ( string $id, string $name, string $web_id = '' )
$id string
$name string
$web_id string (deprecated)

__get() public method

public __get ( string $name ) : mixed
$name string
return mixed

get_field_by_tag() public method

public get_field_by_tag ( string $tag ) : MC4WP_MailChimp_Merge_Field
$tag string
return MC4WP_MailChimp_Merge_Field

get_field_name_by_tag() public method

Deprecation: 4.0
public get_field_name_by_tag ( string $tag ) : string
$tag string
return string

get_interest_category() public method

Get the interest grouping object for a given list.
public get_interest_category ( string $category_id ) : MC4WP_MailChimp_Interest_Category
$category_id string ID of the Interest Grouping
return MC4WP_MailChimp_Interest_Category

get_interest_category_by_interest_id() public method

Since: 4.0
public get_interest_category_by_interest_id ( string $interest_id ) : MC4WP_MailChimp_Interest_Category
$interest_id string
return MC4WP_MailChimp_Interest_Category

get_interest_category_name() public method

Get the name of an interest category by its ID
Deprecation: 4.0
public get_interest_category_name ( string $category_id ) : string
$category_id string
return string

get_web_url() public method

Get link to this list in MailChimp
public get_web_url ( ) : string
return string

Property Details

$id public property

ID of this list for API usage
public $id

$interest_categories public property

public MC4WP_MailChimp_Interest_Category[] $interest_categories
return MC4WP_MailChimp_Interest_Category[]

$merge_fields public property

public MC4WP_MailChimp_Merge_Field[] $merge_fields
return MC4WP_MailChimp_Merge_Field[]

$name public property

Name of this list
public $name

$subscriber_count public property

Number of subscribers on this list
public $subscriber_count

$web_id public property

Web ID of this list in MailChimp.com
public $web_id