Carbon Fields

# Plugin Quickstart

There is a separate package which loads Carbon Fields as a WordPress plugin. Here's how to set it up:

  1. Browse to your root WordPress directory

  2. Execute the following in your terminal of choice:

composer require htmlburger/carbon-fields-plugin
  1. Add the following to the top of your functions.php file:
use Carbon_Fields\Container;
use Carbon_Fields\Field;

add_action( 'carbon_fields_register_fields', 'crb_attach_theme_options' );
function crb_attach_theme_options() {
    Container::make( 'theme_options', __( 'Theme Options' ) )
        ->add_fields( array(
            Field::make( 'text', 'crb_text', 'Text Field' ),
        ) );
}

add_action( 'after_setup_theme', 'crb_load' );
function crb_load() {
    require_once( 'vendor/autoload.php' );
    \Carbon_Fields\Carbon_Fields::boot();
}
  1. Open up /wp-admin/ - you now have a brand new "Theme Options" admin section with a text field

If your composer.json is somewhere other than your WordPress root directory, you will have to add the following to it (replacing YOUR_DESIRED_LOCATION):

"extra": {
    "installer-paths": {
        "YOUR_DESIRED_LOCATION/vendor/{$vendor}/{$name}/": ["type:wordpress-plugin"]
    }
}

# Without Composer

In case you do not wish to use composer to install Carbon Fields, you can also use one of our prebuilt zip packages:

  1. Download https://carbonfields.net/zip/latest/ (opens new window) or visit https://carbonfields.net/release-archive/ (opens new window) and choose a download manually

  2. Upload the .zip by using the "Upload Plugin" button on the Plugins -> Add New page or unzip and upload it to your plugins/ directory

  3. Add the following to the top of your functions.php file:

use Carbon_Fields\Container;
use Carbon_Fields\Field;

add_action( 'carbon_fields_register_fields', 'crb_attach_theme_options' );
function crb_attach_theme_options() {
    Container::make( 'theme_options', __( 'Theme Options' ) )
        ->add_fields( array(
            Field::make( 'text', 'crb_text', 'Text Field' ),
        ) );
}
  1. Open up /wp-admin/ - you now have a brand new "Theme Options" admin section with a text field

Note: The zip packages use Composer's autoloader PHP classes, but do not require that you have composer installed.

← Usage →