jarednova/timber

This package is abandoned and no longer maintained. The author suggests using the timber/timber package instead.

Plugin to write WordPress themes w Object-Oriented Code and the Twig Template Engine


README

687474703a2f2f692e696d6775722e636f6d2f50 By Jared Novack (@JaredNova) and Upstatement (@Upstatement)

Build Status Coverage Status Dependency Status Scrutinizer Code Quality Latest Stable Version WordPress Download Count HHVM Status Join the chat at https://gitter.im/timber/timber

Because WordPress is awesome, but the_loop isn't

Timber helps you create fully-customized WordPress themes faster with more sustainable code. With Timber, you write your HTML using the Twig Template Engine separate from your PHP files.

This cleans-up your theme code so, for example, your php file can focus on being the data/logic, while your twig file can focus 100% on the HTML and display.

This is what Timber's .twig files look like:

{% extends "base.twig" %}
{% block content %}
<h1 class="big-title">{{foo}}</h1>
<h2 class="post-title">{{post.title}}</h2>
<img src="{{post.thumbnail.src}}" />
<div class="body">
    {{post.content}}
</div>
{% endblock %}

Once Timber is installed and activated in your plugin directory, it gives any WordPress theme the ability to take advantage of the power of Twig and other Timber features.

Looking for docs?

Installation

The GitHub version of Timber requires Composer. If you'd prefer one-click installation, you should use the WordPress.org version.

composer require timber/timber

If your theme is not setup to pull in Composer's autoload file, you will need to

require_once(__DIR__ . '/vendor/autoload.php');

at the top of your functions.php file.

Initialize Timber with

$timber = new \Timber\Timber();

Mission Statement

Timber is a tool for developers who want to translate their HTML into high-quality WordPress themes through an intuitive, consistent and fully-accessible interface.

  • Intuitive: The API is written to be user-centric around a programmer's expectations.
  • Consistent: All WordPress objects can be accessed through polymorphic properties like slug, ID and name.
  • Accessible: No black boxes. Every effort is made so the developer has access to 100% of their HTML.

What does it look like?

Nothing. Timber is meant for you to build a theme on. Like the Starkers or Boilerplate theme it comes style-free, because you're the style expert. Instead, Timber handles the logic you need to make a kick-ass looking site.

Who is it good for?

Timber is great for any WordPress developer who cares about writing good, maintainable code. It helps teams of designers and developers working together. At Upstatement we made Timber because while our entire team needs to participate in building WordPress sites, not everyone knows the ins-and-outs of the_loop(), codex and PHP (nor should they). With Timber your best WordPress dev can focus on building the .php files with requests from WordPress and pass the data into .twig files. Once there, designers can easily mark-up data and build out a site's look-and-feel.

Related Projects

  • Timber Starter Theme The "_s" of Timber to give you an easy start to the most basic theme you can build upon and customize.
  • Timber Debug Bar Adds a debug bar panel that will show you which template is in-use and the data sent to your twig file.
  • TimberPhoton Plug-in to use JetPack's free Photon image manipulation and CDN with Timber.
  • Timber CLI A CLI for Timber.
  • Timber Sugar A catch-all for goodies to use w Timber.
  • Timmy Advanced image manipulation for Timber.
  • Twig The template language used by Timber.

Projects that use Timber

  • Gantry5 a framework for theme development
  • Branch Bootstrap + Timber = Branch starter theme!

Helpful Links

Support

Please post on StackOverflow under the "Timber" tag. Please use GitHub issues only for specific bugs, feature requests and other types of issues.

Should I use it?

It's MIT-licensed, so please use in personal or commercial work. Just don't re-sell it. Timber is used on hundreds of sites (and tons more we don't know about)

Contributing

Read the contributor guidelines in the wiki.

Documentation for Timber classes and functions is auto generated, so any changes to the object reference docs should be made by editing the function's DocBlock. To make a change to one of the guides, edit the relevant file in the docs directory.

To publish docs: 1. composer install if not already run 2. Clone the timber/slate repo at the same directory level as Timber 3. From the root of the slate directory, run these commands:

gem install bundler
bundle install
sh publish-docs.sh