[ Close ] Learn more about our custom WordPress development services at htmlBurger


Documentation > Carbon Fields > Plugin Quickstart

Plugin Quickstart

There is a seprate 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
  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', 'crb' ) )
            ->add_fields( array(
                Field::make( 'text', 'crb_text', 'Text Field' ),
            ) );
    add_action( 'after_setup_theme', 'crb_load' );
    function crb_load() {
        require_once( ABSPATH . '/vendor/autoload.php' );
  4. 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"]

Excited about Carbon Fields? Spread the word!