warengonzaga / shortcodes-wp Goto Github PK

A WordPress shortcode plugin to automagically display WordPress information. Simple and lightweight, no annoying ads and fancy settings.

License: GNU General Public License v3.0

PHP 100.00%

wordpress plugin shortcode shortcodes hooks no-ads simple lightweight hacktoberfest

shortcodes-wp's Introduction

Shortcodes WP

📢 Nominate (@WarenGonzaga) as GitHub Star. If you appreciate his hardwork and dedication to open source.

A WordPress shortcode plugin to automagically display WordPress information. Simple and lightweight, no annoying ads and fancy settings.

😎 Demo

(coming soon...)

📖 Documentation

The complete documentation can be found here:

📦 Installation

To be able to start using this plugin just download the latest release here.

Upload the plugin (.zip file) to the /wp-content/plugins/ directory.
Activate the WP Disease Tracker WordPress plugin through the 'Plugins' menu in WordPress.

🕹️ Usage

Simply copy the shortcode below and paste it somewhere on the front-end of your WordPress website.

[wpuser_firstname] //display current user's first name
[wpuser_lastname] //display current user's last name

Date

[wpinfo_current_day] //display current day e.g. Tuesday
[wpinfo_current_month] //display current month e.g. November
[wpinfo_current_year] //display current year e.g. 2020

Display current date, using the format set in Settings > Date format

[wpinfo_current_date] OR
[wpinfo_current_date format="Y/m/d"]

[wpuser_query_param arg="s"] //display a query parameter from the URL e.g. the search parameter

More shortcodes coming...

🎯 Contributing

Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the dev branch. Thank you!

💬 Discussions

For any questions, suggestions, ideas, or simply you want to share your experience in using this project, feel free to share and discuss it to the community!

🐛 Issues

If you're facing a problem in using Shortcodes WP please let me know by creating an issue here. I'm here to help you!

🍀 Sponsors and Supporters

Love what I do? Send me some coffees! Can't send coffees? Nominate me for a GitHub Star instead! Your coffee donation and support will help me to continue working on open-source projects like this.

🌏 Community

Wanna contribute to my projects? Join today and contribute!

📋 Code of Conduct

Read the project's code of conduct.

📃 License

Shortcodes WP is licensed under GNU General Public License v3.

📝 Author

Shortcodes WP is created by Waren Gonzaga, with the help of awesome contributors.

💻 Made with 💖 and ☕ by Waren Gonzaga with YHWH 🙏 | Citizen of Heaven

shortcodes-wp's People

Contributors

Stargazers

Watchers

Forkers

christoflee actuallyconnor adamsbriscoe

shortcodes-wp's Issues

get the latest post URL shortcode

Adding an ability to get the latest post URL by using shortcode only.
Inspired by this plugin that is outdated.

Would be a good idea to add this to the list of useful shortcodes.

This would be part of wpinfo family.

official documentation for shortcodes-wp

I need help in documenting this project to my gitbook account that will be available in this URL.

shortcode for online users

It is a good suggestion, a shortcode to easily display which users are currently online.

wpinfo shortcode for wordpress related info

Sample use case, I want to quickly access the time and date via shortcode.
Use something like: [wpinfo_current_month] as an example.

update sponsor and supporters badges

This issue is for me, I added it here as a to-do item for my task management.

query string as shortcode

It is useful to display the current query string as a shortcode in some cases.

namespace for shortcodes

At the moment, if a theme or plugin has the same name as our functions then there will be an error.

I suggest re-writing what exists currently into a PHP Class and use namespaces.

I can do this for you but please let me know if you would like this. Again, please add 'Hacktoberfest'.

submit the plugin to official WordPress plugin repository

This issue is for me, I'm gonna finalize everything before submitting it to the WP team for listing.

shortcode for back to previous page

I know it is a bit of a bloat function, but it will make your life easier by just adding a shortcode only to a certain page. Also adding an option too, on where to redirect the visitor? 🤷‍♂️

get the current URL w/out query parameters

The example use case for this is when you want to get the current URL of the page and add it as part of your anchor tag.

<a href="[wpinfo_current_url]?status=1">Sample</a>

Expected Usage

[wpinfo_current_url with_param="false | true"]

For me, this is a useful feature to add as part of our shortcode WordPress information.

file structure (uppercase and lowercase file naming)

There is a reason behind file naming in lowercase. As a tradition, I will re-structure the project file naming.
Here's the technical reason why: https://softwareengineering.stackexchange.com/questions/301691/readme-txt-vs-readme-txt

I will keep the important files in uppercase.

automate workflow

I want to automate things here to make things easier for maintenance.

Automate release / changelog.
Automate tests for WordPress.
Automate adding contributors to the README file.
Automate building the plugin and push to the WP repository.

These are the tasks that need to be done for me to make this project more maintainable.

For contributors, if you can do these things I have 40+ repositories that need this.
As an alternative, I'm working on a solution to make this easier for everyone.

plugin repo banner image and icon

I want to add a special repo banner here for the project and an icon I guess for the project.

implement WordPress coding standards

Things like:

Format of comments
PHP Doc blocks

I am happy to do this change, please let me know and update this issue with 'Hacktoberfest'.

variables and options must be escaped when echo'd

I submitted it to the WP plugin repository for my other project related to the shortcodes so I want to implement it here too. Double-check the plugin if following the secure way of coding the plugin.

Reference: https://developer.wordpress.org/plugins/security/securing-output/