Backup Field

Overview

The backup field type provides options for importing and exporting settings. This is useful for creating backups of configurations or transferring settings between different environments.

Field Configuration

Below is the general structure for defining a backup field:

array(
    'type'  => 'backup',
),

Specific Parameters

Parameter	Type	Default	Description
type	string	-	Set to backup to define a backup field.
title	string	-	Title for the backup section.

General Parameters

Parameter	Type	Default	Description
id	string	-	Unique identifier for the field.
type	string	-	Defines the field type.
title	string	-	The title displayed for the field.
subtitle	string	-	The text displayed under the title.
class	string	-	Field additional class.
data_type	string	serialize	Defines how data is stored (e.g., serialize).
name	string	-	Custom name for the field.
placeholder	string	Not selected	Placeholder text for the input.
attributes	array	array()	Custom HTML attributes.
before	string	-	Content to display before the field.
after	string	-	Content to display after the field.
description	string	-	A detailed description of the field.
desc	string	-	A short description, used if description is not set.
help	string	-	Additional helper text for guidance. Usually show on the top right corner of the field.
error	string	-	Error message to display when validation fails.
dependencies	array	-	Show/Hide a field base on another field value.

Example Usage

Here’s an example of how a backup field might be defined in a settings panel:

array(
    'id'    => 'backup_settings',
    'type'  => 'backup',
    'title' => __( 'Backup & Import', 'textdomain' ),
),

Features

• Export Settings: Allows users to export their configuration settings.
• Import Settings: Provides an option to import previously saved settings.
• Backup & Restore: Helps in creating backups for easy restoration of settings.

Notes

• The backup feature simplifies the migration process for settings.
• Ensures users can restore previous configurations effortlessly.
• Useful for developers and administrators who need to transfer settings between environments.