Quickstart
This guide will show you how to install the Carbon Fields library using composer. To install Carbon Fields as a WordPress plugin, please follow the Plugin Quickstart
guide instead.
- Browse to your theme directory
- Execute the following in your terminal of choice:
composer require htmlburger/carbon-fields
-
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', 'crb' ) ) ->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(); }
- Open up
/wp-admin/
– you now have a brand new "Theme Options" admin section with a text field
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:
- Download https://carbonfields.net/zip/latest/ or visit https://carbonfields.net/release-archive/ and choose a download manually
- Unzip and place the
carbon-fields/
directory in your theme -
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', 'crb' ) ) ->add_fields( array( Field::make( 'text', 'crb_text', 'Text Field' ), ) ); } add_action( 'after_setup_theme', 'crb_load' ); function crb_load() { require_once( 'carbon-fields/vendor/autoload.php' ); \Carbon_Fields\Carbon_Fields::boot(); }
- 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.