dudley/banner

Module to render a standard banner with a heading.

dev-master 2017-04-24 03:48 UTC

Requires

• dudley/abstract-banner: dev-master

GPL-2.0

• Jeremy Ward
• 3five, Inc.

README

This package is designed for use with the Dudley plugin. You can include it in your project by requiring this repository in the Dudley plugin's composer.json file.

In the require object of composer.json, add this line:

"dudley\banner": "dev-master"

How to Use in Template Files

Like all modules in the Dudley Patterns Framework, action names are generated from both the object's $meta_type property and its $action_name property. The format is dudley_{$meta_type}_{$action_name}.

Thus, if you are using Advanced Custom Fields, the code to include in your template file to render the banner would be: <?php do_action( 'dudley_acf_banner' ); ?>

Available Filters

• dudley_banner_image_size: Alters the size of the banner image (default is 'large'). Return an empty string for the full-sized image.

How to Override the Markup in Your Own Template File

1. If none exists, create a directory in your theme named dudley-modules
2. Add a file named banner.php in the dudley-modules directory.