thedigitaloctopus / wp-cf-snippets Goto Github PK

## CF Snippets

The CF Snippets plugin gives Admin users the ability to create chunks of content (including HTML content) to be inserted into posts, widgets and front end display with an easy to use Admin interface (Note, this does not allow a user to insert arbitrary PHP).  This functionality gives the Admin users easy ability to edit the chunks of code without editing PHP/HTML files.  The plugin provides PHP functions for display of Snippets, as well as WordPress shortcodes.  On the post edit screen, the plugin provides a TinyMCE button for easy insertion of Snippets shortcodes.

** NOTE: Plugin requires WordPress 3.1 **

### Usage

The Snippets admin page allows for the creation of multiple snippets. From the plugin page:

	Paste in HTML content for a snippet and give it a name. The name will be automatically "sanitized:" lowercased and all spaces converted to dashes.

	To insert a snippet in your template, type <?php cfsp_content('my-snippet-name'); ?>
	Use the shortcode syntax: [cfsp name="my-snippet-name"] in post or page content to insert your snippet there.

	Or use snippet widgets wherever widgets can be used.

	To access files in your current theme template directory from within a snippet, type {cfsp_template_url}. That will be replaced with, for example, `http://example.com/wordpress/wp-content/themes/mytheme/`.

### Template Tags

The Snippets plugin provides PHP "template tags" for easy display of Snippet data.  The functions will display content based on snippet key.  The functions also provide the ability to automatically create a snippet if one does not exist.

The following function will echo the content for `snippet-1`:

	<?php cfsp_content('snippet-1'); ?>

Or to just get the snippet content without echoing:

	<?php $snippet = cfsp_get_content('snippet-1'); ?>
	
The function will also create the snippet with some default content, then display the content.  When the snippet is created it will have a default description of "Snippet 1":

	<?php cfsp_content('snippet-1', 'this is the snippet content for snippet-1', true); ?>
	
Or to just get the snippet content without echoing:

	<?php $snippet = cfsp_get_content('snippet-1', 'this is the snippet content for snippet-1', true); ?>

The function can also allows the user to create a custom description when creating the default snippet:

	<?php cfsp_content('snippet-1', 'this is the snippet content for snippet-1', true, array('description' => 'Description for Snippet 1')); ?>
	
Or to just get the snippet content without echoing:

	<?php $snippet = cfsp_get_content('snippet-1', 'this is the snippet content for snippet-1', true, array('description' => 'Description for Snippet 1')); ?>

### Shortcodes

The Snippets plugin also provides WordPress shortcodes for easy display of the Snippet data.  The shortcode will display data based on snippet key.  The shortcode does not provide the ability to create the snippet if it does not exist.  So if a snippet is to be displayed it will need to be created before it can be displayed.

To display a snippet in WordPress post data, simply add:
	
	[cfsp name="snippet-1"]
	
The plugin also provides a TinyMCE button to the WYSIWYG on the post edit screen.  The "cog" icon can be clicked and then a snippet selected to have the shortcode displayed.  

To add the snippet shortcode:

- Place the cursor in the WYSIWYG where the snippet should be displayed
- Click the "cog" icon
- Click on the Snippet Description that is desired to be displayed

### Post Created Snippets

The Snippets plugin provides the ability to create snippets on the Post/Page edit screens.  Snippets created on the post edit screen have a button for easily adding the snippet content to the content of the post via Shortcode.  Snippets created on a post or page edit screen will always be displayed there until the snippet is removed using the "Remove Snippet from this Post" button.  Snippets created in posts are also displayed on the Snippets settings screen, and can be added to any post/page desired using the Snippets shortcode.  These snippets can also be used with the Snippets template tag wherever desired.  To add a Post/Page created snippet to the content of a post, simply place the cursor in the position to insert the shortcode and click the "Add to Content" button for the Snippet desired.

### Widgets

The Snippets plugin also provides WordPress Widgets for easy display of Snippet data.  The Widget will display content based on a snippet selected from a drop down menu on the Widget admin page.  The Widget also provides a Title section for compliance with custom themes.

To add the Snippet Widget:

- Navigate to the Widgets admin page under the Appearance section of the WordPress Admin Navigation
- Click on the CF Snippets widget and drag it into the desired place in the desired sidebar
- Add a title (if desired)
- Select the Snippet to be displayed
- Click the Save button to save changes

For more information on how to use WordPress widgets, see this Documentation: http://en.support.wordpress.com/widgets/