Skip to Content
Menu

cf7_debug_info()

Adds contextual information to all Contact Form 7 submissions.

PHP July 1, 2022

Usage

PHP
cf7_debug_info($cf7_instance)

Parameters

$cf7_instance
(Required) (Object) An instance of the CF7 form submission
Default: None

Parameter Notes

Use WPCF7_Submission::get_instance(); as the $cf7_instance parameter.

However, in most cases, child theme developers would interface with this function via the nebula_cf7_debug_info filter.

Request or provide clarification »

Examples

Get an array of debug info

PHP
$nebula_debug_info = nebula()->cf7_debug_info(WPCF7_Submission::get_instance());

Add custom data to the debug information

PHP
add_filter('nebula_cf7_debug_info', function($debug_info){
    //Add custom data to the debug info
    if ( get_option('tier_name') ){
        $debug_info['tier'] = get_option('tier_name'); //Add an example item
    }
    
    return $debug_info; //Always return in filters!
});

Remove data from the debug information

PHP
add_filter('nebula_cf7_debug_info', function($debug_info){
    unset($debug_info['nebula_anonymized_ip']); //Remove this item
    return $debug_info; //Always return in filters!
});

Additional Notes

This debug info is sent to the recipient of the form if the shortcode [debuginfo] appears in the message of the Contact Form 7 form settings.

This debug info is stored in WordPress within the Nebula CF7 Submissions custom post type (which appears within the “Contact” admin menu item). It may appear in other form storage systems like the Advanced CF7 DB plugin, but mileage may vary.

Was this page helpful? Yes No


    A feedback message is required to submit this form.


    Please check that you have entered a valid email address.

    Enter your email address if you would like a response.

    Thank you for your feedback!

    Source File

    Located in /libs/Functions.php on line 3236.

    1 Hook

    Find these filters and actions in the source code below to hook into them. Use do_action() and add_filter() in your functions file or plugin.

    Filters
    "nebula_cf7_debug_info"
    Need a new filter hook? Request one here.

    Actions
    This function has no action hooks available. Request one?

    PHP
            public function cf7_debug_info($cf7_instance){
                if ( !is_object($cf7_instance) ){
                    return array();
                }
    
                $debug_info = array();
    
                $debug_info['nebula_timestamp'] = date('U');
                $debug_info['nebula_date_formatted'] = date('l, F j, Y \a\t g:ia');
                $debug_info['nebula_version'] = $this->version('full') . ' (Committed ' . $this->version('date') . ')';
                $debug_info['nebula_child_version'] = $this->child_version('full');
                $debug_info['nebula_session_id'] = sanitize_text_field($this->nebula_session_id());
                $debug_info['nebula_ga_cid'] = sanitize_text_field($this->ga_parse_cookie());
                $debug_info['nebula_utms'] = sanitize_text_field(htmlspecialchars_decode($this->utms()));
    
                //Logged-in User Info
                $user_id = (int) $cf7_instance->get_meta('current_user_id');
                if ( !empty($user_id) ){
                    //Staff
                    if ( $this->is_dev() ){
                        $debug_info['nebula_staff'] = 'Developer';
                    } elseif ( $this->is_client() ){
                        $debug_info['nebula_staff'] = 'Client';
                    } elseif ( $this->is_staff() ){
                        $debug_info['nebula_staff'] = 'Staff';
                    }
    
                    $user_info = get_userdata($user_id);
    
                    $debug_info['nebula_user_id'] = $user_info->ID;
                    $debug_info['nebula_username'] = $user_info->user_login;
                    $debug_info['nebula_display_name'] = $user_info->display_name;
                    $debug_info['nebula_email'] = $user_info->user_email;
    
                    if ( get_the_author_meta('phonenumber', $user_info->ID) ){
                        $debug_info['nebula_phone'] = get_the_author_meta('phonenumber', $user_info->ID);
                    }
    
                    if ( get_the_author_meta('jobtitle', $user_info->ID) ){
                        $debug_info['nebula_job_title'] = get_the_author_meta('jobtitle', $user_info->ID);
                    }
    
                    if ( get_the_author_meta('jobcompany', $user_info->ID) ){
                        $debug_info['nebula_company'] = get_the_author_meta('jobcompany', $user_info->ID);
                    }
    
                    if ( get_the_author_meta('jobcompanywebsite', $user_info->ID) ){
                        $debug_info['nebula_company_website'] = get_the_author_meta('jobcompanywebsite', $user_info->ID);
                    }
    
                    if ( get_the_author_meta('usercity', $user_info->ID) && get_the_author_meta('userstate', $user_info->ID) ){
                        $debug_info['nebula_city_state'] = get_the_author_meta('usercity', $user_info->ID) . ', ' . get_the_author_meta('userstate', $user_info->ID);
                    }
    
                    $debug_info['nebula_role'] = $this->user_role();
                }
    
                //Bot detection
                if ( $this->is_bot() ){
                    $debug_info['nebula_bot'] = 'Bot detected';
                }
    
                //WPML Language
                if ( defined('ICL_LANGUAGE_NAME') ){
                    $debug_info['nebula_language'] = ICL_LANGUAGE_NAME . ' (' . ICL_LANGUAGE_CODE . ')';
                }
    
                //Device information
                if ( isset($this->super->server['HTTP_USER_AGENT']) ){
                    $debug_info['nebula_user_agent'] = sanitize_text_field($this->super->server['HTTP_USER_AGENT']);
                }
    
                $debug_info['nebula_device_type'] = ucwords($this->get_device('formfactor'));
                $debug_info['nebula_device'] = $this->get_device('full');
                $debug_info['nebula_os'] = $this->get_os();
                $debug_info['nebula_browser'] = $this->get_browser('full');
    
                //Anonymized IP address
                $debug_info['nebula_anonymized_ip'] = sanitize_text_field($this->get_ip_address());
    
                $debug_info = map_deep($debug_info, 'sanitize_text_field'); //Deep sanitization of the full data array
    
                return apply_filters('nebula_cf7_debug_info', $debug_info);
            }
    

    Override

    This function can not be short-circuited with an override filter. Request one?