https://github.com/codemonkey-jack/maera
WordPress theme framework utilizing Twig + Timber
https://github.com/codemonkey-jack/maera
Last synced: about 1 month ago
JSON representation
WordPress theme framework utilizing Twig + Timber
- Host: GitHub
- URL: https://github.com/codemonkey-jack/maera
- Owner: codemonkey-jack
- License: mit
- Created: 2014-04-28T10:32:41.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-03-18T18:32:34.000Z (about 8 years ago)
- Last Synced: 2025-12-20T11:26:06.617Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 4.44 MB
- Stars: 34
- Watchers: 6
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Maera
=====
[](https://codeclimate.com/github/presscodes/maera)
**Maera** is a developer-friendly theme that allows you to quickly prototype sites and extend it with your own custom plugins.
**It's a kick-ass open-minded theming framework.**
It is completely open-source, licensed under the MIT license
In its heart it uses the [twig templating engine](http://twig.sensiolabs.org/) and the WordPress Customizer.
With Maera we're introducing the concept of theme **shells**. An easy way to completely customize the theme with your own markup, css, scripts and functionality to meet your own needs!
Maera is a WordPress theme and as such it follows the default WordPress [template hierarchy](http://wphierarchy.com/). However, we do have some extra stuff going on under the hood that we have found make life a lot easier both for skilled developers and for novice users that may not be php developers.
In addition to the default template files that you can use if you want, we also provide a "views" folder that contains "twig" files. You can learn more about the twig language by clicking on [this link](http://twig.sensiolabs.org/).
`twig` files have a structure and syntax a lot easier and more user-friendly than php. For example if you wanted to echo something in PHP, you would do this:
```php
```
In twig however it's a lot simpler than that:
```twig
{{ foo }}
```
You can learn more about the syntax and naming conventions by reading the [Timber Docs](https://github.com/jarednova/timber/wiki).
To add your own templates you can create a [Child Theme](href="http://codex.wordpress.org/Child_Themes) and either create custom php template files like you would do on every other WordPress theme, or custom twig templates.
The template hierarchy of the twig files is the same as the [default WordPress templates structure](href="http://wphierarchy.com/), simply by replacing the `.php` suffix with `.twig`.
You can keep your `.twig` files in the root of your child theme, or a `/views` folder if you want to keep things a little more organized.
---
## Template hierarchy on the Maera theme:
Content Template
Sidebar Template
Author Archives
author-{nicename}.twig, author-{ID}.twig, author.twig, archive.twig, index.twig
sidebar.twig
Category Archives
category-{slug}.twig, category-{ID}.twig, category.twig, archive.twig, index.twig
sidebar-category-{term_id}.twig, sidebar-category.twig, sidebar.twig
Custom Post Type Archives
archive-{post_type}.twig, archive.twig, index.twig
sidebar-archive-{post_type}.twig, sidebar.twig
Custom Taxonomy Archives
taxonomy-{term}.twig, taxonomy-{taxonomy}.twig, archive.twig, index.twig
sidebar-term-{term_id}.twig, sidebar-taxonomy-{taxonomy}.twig, sidebar-taxonomy.twig, sidebar.twig
Date Archives
date.twig, archive.twig, index.twig
sidebar-date.twig, sidebar.twig
Tag Archives
tag-{slug}.twig, tag-{ID}.twig, tag.twig, archive.twig, index.twig
sidebar-tag-{term_id}.twig, sidebar-tag.twig, sidebar.twig
Single Post
single-post.twig, single.twig, index.twig
sidebar-{post-ID}.twig, sidebar-post.twig, sidebar-single.twig, sidebar.twig
Single Page
page-{slug}.twig, page-{ID}.twig, page.twig, index.twig
sidebar-{post-ID}.twig, sidebar-page.twig, sidebar-single.twig, sidebar.twig
## The stucture of a rendered page
We divided the pages in sub-files in ordet to make them more modular.
You can see the twig file template parts on the below diagram:
[Get this file for a larger view](https://press.codes/wp-content/uploads/template-structure.png)
## Post properties in twig files
```
{{ post.ID }} // ID of the post
{{ post.post_author }} // ID of the post author
{{ post.post_date }} // timestamp in local time
{{ post.post_date_gmt }} // timestamp in gmt time
{{ post.post_content }} // Full (unprocessed) body of the post
{{ post.post_title }} // title of the post
{{ post.post_excerpt }} // excerpt field of the post, caption if attachment
{{ post.post_status }} // post status: publish, new, pending, draft, auto-draft, future, private, inherit, trash
{{ post.comment_status }} // comment status: open, closed
{{ post.ping_status }} // ping/trackback status
{{ post.post_password }} // password of the post
{{ post.post_name }} // post slug, string to use in the URL
{{ post.post_modified }} // timestamp in local time
{{ post.post_modified_gmt }} // timestatmp in gmt time
{{ post.post_parent }} // id of the parent post.
{{ post.guid }} // global unique id of the post
{{ post.menu_order }} // menu order
{{ post.post_type }} // type of post: post, page, attachment, or custom string
{{ post.post_mime_type }} // mime type for attachment posts
{{ post.comment_count }} // number of comments
{{ post.terms }} // taxonomy terms
{{ post.custom_field }} // whatever custom field you've added (in the post_meta table)
```