Custom Post Type : Tutorial Pages

Simple custom post type for tutorial posts on ParkourLabs.com.

1. Table of Contents

• 1. Table of Contents
• 2. About The Project
  • 2.1. Built With
  • 2.2. Installation
• 3. Usage
  • 3.1. Shortcode [tutorial_posts]
    • 3.1.1. Simple Example:
    • 3.1.2. Add attributes:
    • 3.1.3. Different content fields:
    • 3.1.4. Add taxonomy / tag filters:
    • 3.1.5. Content Note:
• 4. Customising
• 5. Contributing
• 6. License
• 7. Contact
• 8. Changelog

2. About The Project

Tutorial posts are used on the parkourlabs.com website. Heavily used to list the hundreds of tutorial videos on the site.

(back to top)

2.1. Built With

This project was built with the following frameworks, technologies and software.

• ACF Pro
• Composer
• PHP
• Wordpress

(back to top)

2.2. Installation

These are the steps to get up and running with this plugin.

1. Clone the repo into your wordpress plugin folder

   git clone https://github.com/IORoot/wp-plugin__cpt--tutorial ./wp-content/plugins/cpt-tutorial
   

2. Activate the plugin.

(back to top)

3. Usage

A new menu option Tutorials will appear in the admin sidebar. Here you can define new posts, category and tags.

Contains:

1. Tutorials CPT
2. Tutorials Taxonomy
3. Tutorials Tags
4. Tutorials Shortcode

3.1. Shortcode [tutorial_posts]

3.1.1. Simple Example:

[tutorial_posts] Show the {{post_title}} [/tutorial_posts]

3.1.2. Add attributes:

[tutorial_posts posts_per_page='10'] Show the {{post_title}} [/tutorial_posts]
[tutorial_posts post_type='demonstration'] Show the {{post_title}} [/tutorial_posts]

3.1.3. Different content fields:

[tutorial_posts posts_per_page='1']

     <h2>Post Fields</h2>
     {{post_title}} 
     {{permalink}} 

     <h2>Sanitize Fields to make them like a slug</h2>
     {{post_title:sanitize}} 

     <h2>Meta Fields</h2>
     {{meta_field}} 

     <h2>Image Fields</h2>
     {{image}} 
     {{path}} 
     {{file}} 
     {{width}} 
     {{height}} 

[/tutorial_posts]

3.1.4. Add taxonomy / tag filters:

[tutorial_posts cat="cat-leaps" tag="slowmo"] Show the {{post_title}} [/tutorial_posts]

3.1.5. Content Note:

If the post_content contains {{moustaches}} itself, these will also be parsed. So you can Add variables into your content.

4. Customising

None.

(back to top)

5. Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

6. License

Distributed under the MIT License.

MIT License

Copyright (c) 2022 Andy Pearson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(back to top)

7. Contact

Author Link: https://github.com/IORoot

(back to top)

8. Changelog

v1.0.0 - Initial.