Shortcode : Facts
A helper library of small functions.
1. Table of Contents
- 2.1. Built With
- 2.2. Installation
2. About The Project
A single shortcode to run various small functions on wordpress.
2.1. Built With
This project was built with the following frameworks, technologies and software.
2.2. Installation
These are the steps to get up and running with this plugin.
- Clone the repo into your wordpress plugin folder
git clone https://github.com/IORoot/wp-plugin__shortcode--facts ./wp-content/plugins/shortcode-facts - Composer.
cd ./wp-content/plugins/shortcode-facts composer install
3. Usage
There is a single shortcode [facts] that can be used.
It has a single parameter fact that allows you to select the fact to run. You can add additional parameters if the fact requires it.
The following are available:
[facts fact="posts_of_type_count" type="tutorial"]
Returns the number of posts of the cutom post type "tutorial" that are published.
[facts fact="taxonomy_parents_count" tax="category"]
Return the number of terms in the taxonomy called "category".
[facts fact="taxonomy_random_acf_image" tax="demo_category"]
ACF Pro needs to be installed for this to run. Also the plugin https://github.com/IORoot/wp-plugin__taxonomy--extra needs to be installed.
The https://github.com/IORoot/wp-plugin__taxonomy--extra plugin adds featured images to each taxonomy term.
This fact will return the URL of that featured image of a random taxonomy term in the taxonomy "demo_category".
[facts fact="taxonomy_random_acf_meta" tax="syllabus_category"]
ACF Pro needs to be installed for this to run. Also the plugin https://github.com/IORoot/wp-plugin__taxonomy--extra needs to be installed.
The https://github.com/IORoot/wp-plugin__taxonomy--extra plugin adds featured images to each taxonomy term.
Returns an array of meta-fields for a random term in the taxonomy "syllabus_category".
4. Troubleshooting
none.
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
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.
7. Contact
Author Link: https://github.com/IORoot
8. Changelog
v1.0.0 - initial version