Title: WP Boilerplate Shortcode
Author: Mike Schinkel
Published: <strong>2010 年 3 月 28 日</strong>
Last modified: 2010 年 3 月 29 日

---

搜索插件

**该插件尚未通过WordPress的最新3个主要版本进行测试**。 当与较新版本的WordPress一起
使用时，可能不再受到维护或支持，并且可能会存在兼容性问题。

![](https://s.w.org/plugins/geopattern-icon/wp-boilerplate-shortcode.svg)

# WP Boilerplate Shortcode

 作者：[Mike Schinkel](https://profiles.wordpress.org/mikeschinkel/)

[下载](https://downloads.wordpress.org/plugin/wp-boilerplate-shortcode.1.0.3.zip)

 * [详情](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/#description)
 * [评价](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/#reviews)
 *  [安装](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/#installation)
 * [开发进展](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/#developers)

 [支持](https://wordpress.org/support/plugin/wp-boilerplate-shortcode/)

## 描述

This plugin provides a shortcode that when inserted will display the body from a
referenced “_boilerplate_.” A boilerplate is a special post type defined by this
plugin. References can be made by title, path or ID. Below is a list of shortcode
attributes used by the boilerplate shortcode. Examples are given for hypothetical“
_Copyright_” and “_Payment Terms._” All attributes are optional except one of “_byid_“,“
_bypath_” or “_bytitle_” must be specified:

 * **bytitle**: The full case-sensitive title of the boilerplate, i.e. “_Copyright_”
   or “_Payment Terms_“
 * **bypath**: The editable lowercase path for the boilerplate, i.e. “_copyright_”
   or “_payment-terms_” (vs. “_/boilerplates/copyright/_” or “_/boilerplates/payment-
   terms/_“)
 * **byid**: Refers to the internal ID from the wp_posts table for the boilerplate
   post, i.e. 234 or 1273
 * **showtitle**: “_true_” or “_false_” (defaults to “_false_“); if “_true_” boilerplate
   content will be prefixed with the title of the boilerplate as entered in the 
   edit screen, or optionally with a “_title_” attribute you specify.
 * **title**: Use to override the displayed title of the boilerplate in specific
   cases. When “_title_” is specified “_showtitle_” is implicity set to “_true_.”
 * **titletag**: HTML element used to wrap the title when “_showtitle_” is explicity“
   _true_” or “_title_” is set (defaults to “_h3_.”)
 * **id**: The HTML “_id_” attribute applied to the div element that wraps the boilerplate
   and it’s optional title. If not specificed the div will not get have an “_id_”
   set.
 * **class**: The HTML “_class_” attribute applied to the div& element that wraps
   the boilerplate and it’s optional title (defailts to “_boilerplate_.”)

## 屏幕截图

 * [[
 * Editing Boilerplates in the WordPress admin.
 * [[
 * The example “_Copyright_” boilerplate with shortcode attribute callouts.
 * [[
 * Inserting the “_Copyright_” shortcode into a post.
 * [[
 * Output of the “_Copyright_” shortcode on the web.
 * [[
 * Use of `the_boilerplate()` template tag.
 * [[
 * The example “_Payment Terms_” boilerplate for reference.
 * [[
 * Inserting the “_Payment Terms_” shortcode into a post using most of the shortcode’s
   attributes.
 * [[
 * Output of the “_Payment Terms_” shortcode on the web.

## 安装

To install the WP Boilerplate Shortcode plugin do the following steps:

**Manual Installation from a Direct Download:**

 1. Download the plugin.
 2. Unzip the plugin’s .ZIP file.
 3. Create a sub directory off your WordPress site’s root named wp-content/plugins/
    wp-boilerplate-shortcode/ on your web host.
 4. Upload the plugin’s file to the sub directory just created at your web host.
 5. Login to your WordPress admin console.
 6. Select the Plugin’s “*Edit*” option which generates a listing of plugins.
 7. Activate this plugin.

**Automatic Installation from within the Admin Console:**

 1. Login to your WordPress admin console.
 2. Select “_Add New_” from the plugins menu.
 3. Search for “_wp boilerplate shortcode_.”
 4. Select the plugin and click “_Install_.”
 5. After installation is complete click “_Activate_.”

Once you’ve completed either the manual or automatic installation then you can either
use the `boilerplate` shortcode or the `the_boilerplate()` template tag. See the
[FAQ](https://wordpress.org/extend/plugins/wp-boilerplate-shortcode/faq/) for instructions
on how to use the shortcode and/or the template tag.

## 常见问题

  Where do add/edit my boilerplates?

Look on the left sidebar in your WordPress admin after you’ve activated the plugin
for a menu called “_Boilerplates_.”

  Can you give me examples of using the shortcode?

Sure. Here are some simple examples:

 *     ```
        [boilerplate bytitle="Payment Terms"]
       ```
   
 *     ```
        [boilerplate bypath="copyright"]
       ```
   
 *     ```
        [boilerplate byid="971"]
       ```
   

Here are some more complex examples:

 *     ```
        [boilerplate bytitle="Payment Terms" showtitle="true" title="Terms for Payment" titletag="strong" id="terms"]
       ```
   
 *     ```
        [boilerplate bypath="copyright" class="boilerplate copyright"]
       ```
   

  Where do I type the shortcode?

Type the shortcode into the body of any page, of any post, or of any custom post
type where you want the boilerplate processed.

  Does this plugin provide a boilerplate template tag?

Yes:

 1.     ```
        the_boilerplate('contact-methods'); // 'contact-methods' = the path of the boilerplate.
        ```
    
 2.     ```
        the_boilerplate('Contact Methods','title'); // 'Contact Methods' = the title of the boilerplate.
        ```
    
 3.     ```
        the_boilerplate(123,'id',array('showtitle'=>'true')); // 123 = boilerplate's post ID.
        ```
    

The array parameter in example #3 can contain any [of these attributes](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/..?output_format=md)

  After Adding/Editing a Boilerplate if I click “_View_” I get an error. Why?

If you are still getting this error it’s because WordPress still hasn’t addressed
this problem.

We decided to disallow boilerplates to be seen directly via a URL and as such when
you try to view them WordPress tell you you cannot see it.

An example URL that you might see (assuming you were on the domain `example.com`
and had a boilerplate called “_Copyright_“) might be as follows:

    ```
     http://example.com/boilerplates/copyright/
    ```

_**This URL will not work**_ because boilerplates do not get a page of their own.

Hopefully WordPress will address this soon and you’ll be able to view your boilerplates
from within the admin console.

  What’s the syntax for the shortcode/template tag?

If you are into things from a technical persective it looks like this (angles <>
indicate placeholders, a vertical bar | indicates “_or_“, elipsees indicate one 
or more, parens indicate grouping, and braces {} indicate optional):

 * **Shortcode**:
 *     ```
       [boilerplate (bytitle|bypath|byid)="(||)"
          {showtitle="(true|false)"} {title=""} {titletag=""}
          {id=""} {class="}]
       ```
   

For the template tag the parens are not needed for grouping and the square brackets
indicate optional, which is what most docs use for optional, when it doesn’t conflict
with actual syntax:

 * **Template Tag**:
 *     ```
       the_boilerplate(|| [, 'path'|'title'|'id']
          [, array(['showtitle'=> 'true'|false',] ['title' => '',]
          ['titletag' => '',] ['id' => '',] ['class' => '',] ));
       ```
   

## 评价

此插件暂无评价。

## 贡献者及开发者

「WP Boilerplate Shortcode」是开源软件。 以下人员对此插件做出了贡献。

贡献者

 *   [ Mike Schinkel ](https://profiles.wordpress.org/mikeschinkel/)

[帮助将「WP Boilerplate Shortcode」翻译成简体中文。](https://translate.wordpress.org/projects/wp-plugins/wp-boilerplate-shortcode)

### 对开发感兴趣吗?

您可以[浏览代码](https://plugins.trac.wordpress.org/browser/wp-boilerplate-shortcode/)，
查看[SVN仓库](https://plugins.svn.wordpress.org/wp-boilerplate-shortcode/)，或通过
[RSS](https://plugins.trac.wordpress.org/log/wp-boilerplate-shortcode/?limit=100&mode=stop_on_copy&format=rss)
订阅[开发日志](https://plugins.trac.wordpress.org/log/wp-boilerplate-shortcode/)。

## 更新日志

#### 1.0.2

 * Screenshots!

#### 1.0.1

 * Added `the_boilerplate()` template tag.
 * Restructured `readme.txt` and added FAQ items and more detailed installation 
   instructions.
 * Moved code structure to an encapsulated `WPBoilerplateShortcode` class with class
   methods instead independent functions.

#### 1.0

 * Initial release.

## 额外信息

 *  版本 **1.0.1**
 *  最后更新：**16 年前**
 *  活跃安装数量 **10+**
 *  WordPress 版本 ** 3.0 或更高版本 **
 *  已测试的最高版本为 **3.0.5**
 *  语言
 * [English (US)](https://wordpress.org/plugins/wp-boilerplate-shortcode/)
 * 标签
 * [boilerplate](https://cn.wordpress.org/plugins/tags/boilerplate/)[shortcode](https://cn.wordpress.org/plugins/tags/shortcode/)
 *  [高级视图](https://cn.wordpress.org/plugins/wp-boilerplate-shortcode/advanced/)

## 评级

尚未提交反馈。

[Your review](https://wordpress.org/support/plugin/wp-boilerplate-shortcode/reviews/#new-post)

[查看全部评论](https://wordpress.org/support/plugin/wp-boilerplate-shortcode/reviews/)

## 贡献者

 *   [ Mike Schinkel ](https://profiles.wordpress.org/mikeschinkel/)

## 支持

有话要说吗？是否需要帮助？

 [查看支持论坛](https://wordpress.org/support/plugin/wp-boilerplate-shortcode/)

## 捐助

您愿意支持这个插件的发展吗?

 [ 捐助此插件 ](http://www.charitywater.org/donate/)