GF_System_Report
Class GF_System_Report
Handles the System Report subview on the System Status page.
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:16
Details
- Kind:
class - Namespace:
(global)
Properties
| Property | Type | Description |
|---|---|---|
$background_tasks | null | bool | Whether background tasks are enabled. |
Methods
| Method | Description |
|---|---|
remove_emoji_script() | Remove WordPress's emoji scripts and styles from the system report page. |
system_report() | Display system report page. |
get_system_report_text() | Generate copyable system report. |
get_export() | Get item value for system report. |
get_system_report() | Prepare system report for System Status page. |
prepare_item_value() | Prepare item value for System Status table. |
get_gravityforms() | Get Gravity Forms Info. |
get_database() | Get Gravity Forms database tables. |
get_available_logs() | Get available Gravity Forms log files. |
get_active_plugins() | Get active plugins for system report. |
get_network_active_plugins() | Get network active plugins for system report. |
get_gf_addon() | Returns a GFAddon child class if the plugin slug specified is a Gravity Forms Add-On. |
has_addons_of() | Determine if there are any active Add-Ons that extend a specific class. |
has_payment_callback_addons() | Determine if there are any active Add-Ons with a payment callback. |
get_theme() | Get the theme info. |
get_upgrade_percent_complete() | Returns the percent complete of the migration from the legacy rg_ tables to the gf_ tables. |
is_rest_api_enabled() | Checks whether the REST API is enabled. |
get_timezone() | Gets the WordPress timezone string. |
get_translations() | Get translations info. |
get_cron_events_log() | Gets the items for the cron events log section. |
Method Reference
remove_emoji_script()
public function remove_emoji_script()
Remove WordPress's emoji scripts and styles from the system report page.
Can be removed when WordPress has full support for the wp-exclude-emoji class.
Returns
void
Since: 2.7.1
Source: includes/system-status/class-gf-system-report.php:37
system_report()
public static function system_report()
Display system report page.
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:54
get_system_report_text()
public static function get_system_report_text( $sections )
Generate copyable system report.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$sections | array | System report sections. |
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:161
get_export()
public static function get_export( $array, $item )
Get item value for system report.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$array | array | Array of items. | |
$item | string | Item to get value of. |
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:209
get_system_report()
public static function get_system_report()
Prepare system report for System Status page.
Returns
array
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:317
prepare_item_value()
public static function prepare_item_value( $item, $is_export=false )
Prepare item value for System Status table.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$item | array | System Status item. | |
$is_export | false |
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:704
get_gravityforms()
public static function get_gravityforms()
Get Gravity Forms Info.
Returns
array
Since:
2.22.10.1(Added Background Notifications.)
Source: includes/system-status/class-gf-system-report.php:812
get_database()
public static function get_database()
Get Gravity Forms database tables.
Returns
array
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:931
get_available_logs()
public static function get_available_logs()
Get available Gravity Forms log files.
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:1116
get_active_plugins()
public static function get_active_plugins( $include_gravity_forms=true, $include_gf_addons=true, $include_non_gf_addons=true )
Get active plugins for system report.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$include_gravity_forms | bool | true | Include Gravity Forms in plugin list. |
$include_gf_addons | bool | true | Include Add-On Framework plugins in plugin list. |
$include_non_gf_addons | true | ||
$included_non_gf_addons | bool | Include non Add-On Framework plugins in plugin list. |
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:1190
get_network_active_plugins()
public static function get_network_active_plugins()
Get network active plugins for system report.
Returns
string
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:1314
get_gf_addon()
public static function get_gf_addon( $path )
Returns a GFAddon child class if the plugin slug specified is a Gravity Forms Add-On.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$path | string | Plugin path. (e.g. gravityformsmailchimp/mailchimp.php) |
Returns
object|bool— Returns a subclass of GFAddon if the specified plugin is a Gravity Forms Add-On. Returns false otherwise
Since: 2.2
Source: includes/system-status/class-gf-system-report.php:1393
has_addons_of()
public static function has_addons_of( $class_name )
Determine if there are any active Add-Ons that extend a specific class.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$class_name | string | Class name to check if Add-Ons are a subclass of. |
Returns
bool
Since:
2.22.6(access changed to public)
Source: includes/system-status/class-gf-system-report.php:1438
has_payment_callback_addons()
public static function has_payment_callback_addons()
Determine if there are any active Add-Ons with a payment callback.
Returns
bool
Since:
2.22.6(access changed to public)
Source: includes/system-status/class-gf-system-report.php:1478
get_theme()
public static function get_theme()
Get the theme info.
Returns
array
Since: 2.2.5.9
Source: includes/system-status/class-gf-system-report.php:1518
get_upgrade_percent_complete()
public static function get_upgrade_percent_complete()
Returns the percent complete of the migration from the legacy rg_ tables to the gf_ tables.
Returns
float
Since: 2.3.0.4
Source: includes/system-status/class-gf-system-report.php:1566
is_rest_api_enabled()
public static function is_rest_api_enabled()
Checks whether the REST API is enabled.
Returns
bool
Since: 2.4.0.1
Source: includes/system-status/class-gf-system-report.php:1638
get_timezone()
public static function get_timezone()
Gets the WordPress timezone string.
Based on WP 5.2 options-general.php.
Returns
string
Since: 2.4.11
Source: includes/system-status/class-gf-system-report.php:1652
get_translations()
public static function get_translations()
Get translations info.
Returns
array
Since: 2.5.6
Source: includes/system-status/class-gf-system-report.php:1681
get_cron_events_log()
public static function get_cron_events_log()
Gets the items for the cron events log section.
Returns
array
Since: 2.7.1
Source: includes/system-status/class-gf-system-report.php:1733