Install

To use FX Classes in your Wordpress projects, download the source files and include them in your theme. Composer is recommended to help manage versions.

Installing

The easiest way to get FX Classes is with composer.

composer require vivo-digital/fx-classes:v3.5.1

Or manually add vivo-digital/fx-classes to your project composer.json as a dependency.

// composer.json
{
  "repositories": [
    {
      "type": "vcs",
      "url": "git@bitbucket.org:vivo-digital/fx-classes.git"
    }
  ],
  "require": {
    "vivo-digital/fx-classes": "dev-master"
  }
}

Then install your composer packages like normal:

composer install

The dev-master value means it will get the most recent commit from the master branch.

You can require a particular version (tag) like so:

// composer.json
{
  "vivo-digital/fx-classes": ">=v3.5.1"
}

Include in Theme

Require the entry file at the top of your theme's functions.php file.

// functions.php
require_once 'inc/fx-classes/functions.php';

Updating

Assuming you are using composer, you can upgrade to a specific version using:

composer require vivo-digital/fx-classes:v3.5.1

Debugging

If you don't have Bitbucket SSH keys setup, you will most likely get permission issues in composer. You can use https instead:

// composer.json
{
  "type": "vcs",
  "url": "https://vivo-digital@bitbucket.org/vivo-digital/fx-classes.git"
}