Overview

Packages

  • ACF
  • Automation
    • Actions
    • Activation
    • LeadProfile
    • Menus
    • Queries
    • Rules
    • Triggers
  • CTA
    • Activation
    • AJAXListeners
    • Cloning
    • Core
    • Display
    • EditPage
    • Enqueues
    • GPLSettings
    • LeadsProfile
    • Loading
    • Menus
    • Notices
    • PlacementMetabox
    • PostType
    • Templates
    • Tracking
    • Variations
    • YOAST
  • InboundPro
    • Activation
    • AdminAJAX
    • AutoLoading
    • Cron
    • DataInterface
    • FieldMapping
    • Funnels
    • InboundNowAPI
    • Installer
    • LeadStatuses
    • Menus
    • Notifications
    • Ouath
    • Reports
    • Settings
    • Tracking
    • Translations
    • Updates
  • LandingPages
    • Activation
    • DataInterfaces
    • Management
    • Menus
    • NeedsAttention
    • Notices
    • Sidebars
    • Templates
    • Tracking
    • Variations
    • WelcomeScreen
    • Widgets
  • Leads
    • Activation
    • Akismet
    • BranchControl
    • BulkActions
    • Dashboard
    • Management
    • Notifications
    • Settings
    • Tracking
    • UserProfile
    • WPLogin
  • Mailer
    • Activation
    • Admin
    • ClickTracking
    • DataInterface
    • InboundForms
    • Leads
    • Management
    • Notifications
    • Scheduling
    • Sending
    • Settings
    • ShortcodesAndTokens
    • SparkPost
    • Templates
    • Unsubscribes
    • Variations
    • YoastSEO
  • None
  • Shared
    • APIs
    • CPT
    • DatabaseRoutines
    • DebugTricks
    • DoubleOptin
    • EventManagement
    • FieldMapping
    • InboundForms
    • LeadSorage
    • MarketingButton
    • Menus
    • Notifications
    • Shortcodes
    • ShortcodesAndTokens
    • StandAloneLicensing
    • Tracking
    • VisualEditor
  • xDepreciated

Classes

  • Inbound_Leads
  • Overview
  • Package
  • Class

Class Inbound_Leads

Class Inbound_Leads registers the wp-leads CPT and provides a collection of methods for retrieving and modifying lead data

Package: Shared\CPT
Located at core/shared/classes/class.post-type.wp-lead.php
Methods summary
public
# __construct( )

Initialize Inbound_Leads class

Initialize Inbound_Leads class

public static
# register_post_type( )

Register wp-lead post type

Register wp-lead post type

public static
# register_role_capabilities( )

Register Role Capabilities

Register Role Capabilities

public static
# register_taxonomies( )

Register Category Taxonomy

Register Category Taxonomy

public static
# register_lead_list_columns( $cols )

Adds ID and Double Opt In columns to lead-tags WP List Table

Adds ID and Double Opt In columns to lead-tags WP List Table

public static
# support_lead_list_columns( $out, $column_name, $term_id )

Displays the list id and double option status in the lead-tags WP List Table

Displays the list id and double option status in the lead-tags WP List Table

public static ARRAY
# intval_list_ids( MIXED $lists )

Make sure that all list ids are intval

Make sure that all list ids are intval

Parameters

$lists

Returns

ARRAY
public static
# add_lead_to_list( lead_id $lead_id, list_id $list_id )

Adds lead to list

Adds lead to list

Parameters

$lead_id
INT
$list_id
INT,ARRAY
public static
# remove_lead_from_list( lead_id $lead_id, list_id $list_id )

Removes lead from list

Removes lead from list

Parameters

$lead_id
INT
$list_id
INT, ARRAY
public static
# get_lead_lists_by_lead_id( INT $lead_id )

Get an array of all lead lists belonging to lead id

Get an array of all lead lists belonging to lead id

Parameters

$lead_id
ID of lead

Returns

ARRAY of lead lists with term id as key and list name as value
public static
# create_lead_list( $args )

Adds a new lead list

Adds a new lead list

public static
# update_lead_list( ARRAY $args )

updates a lead list

updates a lead list

Parameters

$args

Retun

ARRAY ontaining list id
public static
# delete_lead_list( $id = null )

Deletes a lead list

Deletes a lead list

public static
# get_lead_lists_as_array( )

Get an array of all lead lists

Get an array of all lead lists

Returns

ARRAY of lead lists with term id as key and list name as value
public static
# get_lead_tags_as_array( )

Get an array of all lead lists

Get an array of all lead lists

Returns

ARRAY of lead lists with term id as key and list name as value
public static
# get_lead_id_by_email( STRING $email )

Search lead by email

Search lead by email

Parameters

$email
email
public static
# get_lead_list_by( STRING $search, INT $list_id )

Get lead list infomration

Get lead list infomration

Parameters

$search
accepts 'id', 'slug', 'name' or 'term_taxonomy_id'
$list_id

Returns

ARRAY
public static
# get_lead_status( $lead_id )

Get lead status given lead id

Get lead status given lead id

Dev

public static
# get_lead_statuses( )

Get lead status given lead id

Get lead status given lead id

Dev

public static
# get_status_lead_count( $status )

Get lead status count given status key

Get lead status count given status key

Dev

public static
# add_tag_to_lead( lead_id $lead_id, tag_id $tag, $append = true )

Adds tag to lead

Adds tag to lead

Parameters

$lead_id
INT
$tag
INT, STRING, ARRAY
$append
public static
# remove_tag_from_lead( lead_id $lead_id, tag_id $list_id )

Remove tag from lead

Remove tag from lead

Parameters

$lead_id
INT
$list_id
INT,STRING,ARRAY
public static
# install_leads_prompt( )

Shows message to install leads when leads is not installed or activated

Shows message to install leads when leads is not installed or activated

public static
# get_leads_count_in_list( list_id $list_id )

Gets number of leads in list

Gets number of leads in list

Parameters

$list_id
of lead list taxonomy object
public static
# get_user_by_lead_id( $lead_id )

Get User Object from lead id

Get User Object from lead id

Parameters

$lead_id
public static
# get_user_by_lead_email( $email_address )

Get User Object from lead email

Get User Object from lead email

Parameters

$email_address
public static
# create_double_optin_page( )

Creates the "Confirm Double Optin Page" if the double optin page id is empty

Creates the "Confirm Double Optin Page" if the double optin page id is empty

public static
# create_double_optin_list( )

Creates a maintenance list

Creates a maintenance list

public static mixed
# get_double_optin_page_id( )

Retrieves double opt in page id

Retrieves double opt in page id

Returns

mixed
public static
# save_double_optin_page_id( $page_id )

Save Double Optin Page ID

Save Double Optin Page ID

Parameters

$page_id
Inbound Pro Plugin - PHP Codex API documentation generated by ApiGen