Admin Page Framework Documentation

Packages

  • AdminPageFramework
    • Common
      • Factory
      • Form
        • FieldType
      • Utility
    • Factory
      • AdminPage
      • MetaBox
      • NetworkAdmin
      • PageMetaBox
      • PostType
      • TaxonomyField
      • TermMeta
      • UserMeta
      • Widget
    • Utility

Classes

  • AdminPageFramework_FieldType
  • AdminPageFramework_FieldType_checkbox
  • AdminPageFramework_FieldType_color
  • AdminPageFramework_FieldType_contact
  • AdminPageFramework_FieldType_export
  • AdminPageFramework_FieldType_file
  • AdminPageFramework_FieldType_hidden
  • AdminPageFramework_FieldType_image
  • AdminPageFramework_FieldType_import
  • AdminPageFramework_FieldType_inline_mixed
  • AdminPageFramework_FieldType_media
  • AdminPageFramework_FieldType_number
  • AdminPageFramework_FieldType_posttype
  • AdminPageFramework_FieldType_radio
  • AdminPageFramework_FieldType_section_title
  • AdminPageFramework_FieldType_select
  • AdminPageFramework_FieldType_size
  • AdminPageFramework_FieldType_submit
  • AdminPageFramework_FieldType_system
  • AdminPageFramework_FieldType_table
  • AdminPageFramework_FieldType_taxonomy
  • AdminPageFramework_FieldType_text
  • AdminPageFramework_FieldType_textarea

Resources

  • Tutorials
  • Support
  • Reporting Issues

Class AdminPageFramework_FieldType_system

The System field type displays site information in a text area field.

Used to create a page that helps to report issues with their server information.

Field Definition Arguments

Field Type Specific Arguments

  • data - (optional, array) an associative array that holds the data to display. The following items are embedded by default. To remove an item, pass an empty value with the key.
    • Current Time - the current time
    • Admin Page Framework - information of used Admin Page Framework
    • WordPress - information of installed WordPress
    • PHP - information of installed PHP
    • Server - information of the server
    • PHP Error Log - PHP error log
    • MySQL - MySQL
    • MySQL Error Log - MySQL error log
    • Browser - Browser
  • print_type - [3.3.6+] (optional, integer) Indicates how the data array should be displayed. 1: readable array representation. 2. the output of the print_r() function. Default: 1.

Common Field Definition Arguments

For common field definition arguments, see AdminPageFramework_Factory_Controller::addSettingField().

Example

array(
    'field_id'      => 'system_information',
    'type'          => 'system',
    'title'         => __( 'System Information', 'admin-page-framework-loader' ),
    'data'          => array(
        'Custom Data'           => __( 'Here you can insert your own custom data with the data argument.', 'admin-page-framework-loader' ),

        // To remove items, set empty values
        'Current Time'          => '',
        'Admin Page Framework'  => '',
    ),
    'save'          => false,
),
Package: AdminPageFramework\Common\Form\FieldType
Since: 3.3.0
Image: http://admin-page-framework.michaeluno.jp/image/common/form/field_type/system.png
Located at factory/_common/form/field_type/system/AdminPageFramework_FieldType_system.php

Methods summary

Magic methods summary

Properties summary

public array $aFieldTypeSlugs
#

Defines the field type slugs used for this field type.

The slug is used for the type key in a field definition array.

$this->addSettingFields(
     array(
         'section_id'    => '...',
         'type'          => 'system',        // <--- THIS PART
         'field_id'      => '...',
         'title'         => '...',
     )
 );
protected array $aDefaultKeys
#

Defines the default key-values of this field type.

The keys are used for the field definition array.

   $this->addSettingFields(
    array(
        'section_id'    => '...',
        'type'          => '...',
        'field_id'      => '...',
        'my_custom_key' => '...',    // <-- THIS PART
    )
);

Remark

$_aDefaultKeys holds shared default key-values defined in the base class.

Related

If you find undocumented functionality, please report it here.

Admin Page Framework