Bamboo

WordPress Custom Post Types

Bamboo - WordPress Custom Post Types is a PHP class to help register and maintain WordPress custom post types. It also comes with some rad built-in properties and methods that can be used in templates to maintain clean code and modular development.

For more information about registering post types, including a full list of options, visit the WordPress Codex.

This class works well with the WordPress Custom Taxonomy class. They were made for each other <3.

Declaring New Post Types

Include custom-post-type.php in your functions.php file, with something like require_once(get_template_directory() . '/includes/custom-post-types.php');.

Declare the various argument arrays (within funtions.php or another include file) to setup the new post type as needed (name is required):

// required
$args['name'] = '';

// optional
$args['labels'] = array(
  'singular' => '',
  'plural'   => '',
  'menu'     => ''
);

$args['options'] = array(
  'public'         => true,
  'hierarchical'   => false,
  'supports'       => array('title', 'editor', 'thumbnail'),
  'has_archive'    => true
);

$args['menu_icon'] = ''; // The Unicode of the desired font

$args['help'] = array(
  array(
    'message'      => ''
  ),
  array(
    'context'      => 'edit',
    'message'      => ''
  )
);

Then create a variable (for future reference, but is not required) from an instance of the bamboo_Custom_Post_Type class:

$PostType = new Bamboo_Custom_Post_Type($args);

You can even quick declare a Post Type by just passing the name as a string. So for a Post Type of movie, just pass:

$Movie = new Bamboo_Custom_Post_Type('movie');

Usage

The custom post type class creates a handfull of useful properties and methods that can be accessed through the post type's instance variable and can be used in template and admin files.

Properties

$PostType->name

The post type slug.

$PostType->lables

An array of the singular, plural and menu lables.

Methods

$PostType->get()

Get all entries assigned to this post type. Accepts an array of arguments, and a boolean value to retrieve just a single value (true, useful to use along side 'include' => $single_id) or an array of results (false).

For example:

$post_types = $PostType->get();

Note: A declaration of global $PostType; might be required on some template files to make use of the required post type's instance.

See the Get Posts => Default Usage codex reference for the list of possible arguments, and the Get Pages => Return codex reference for the list of return values.

Custom Icon

get_font_awesome()

To utilise the menu_icon feature of this class, Font Awesome needs to be reference, and there is nice helper function included in Bamboo that will include Font Awesome in the admin for you. Just call the method before declareing any post types:

/* Include Font Awesome */
Bamboo_Custom_Post_Type::get_font_awesome();

Working with Custom Taxonomies

To get posts within (or maybe even not within) terms of particular taxonomies, you can use the Tax Query option within your get function's $args. For example:

$args = array(
  'tax_query' => array(
    array(
      'taxonomy'         => 'foo_category_slug',
      'field'            => 'bar_term_slug',
      'terms'            => array('qux', 'baz'),
      'include_children' => true,
      'operator'         => 'IN'
    )
  )
);

$post_types = $PostType->get($args);

Flush Rewrites

If there are issues with permalinks and the new post types, even after flushing them in the administrator area (Settings > Permalinks > Save Changes), use the following function to flush permalink rewrites for new custom post types and taxonomies.

add_action('init', 'bamboo_flush_rewrites');
function bamboo_flush_rewrites()
{
  global $wp_rewrite;
  $wp_rewrite->flush_rules();
}