WordPress Transient API

This library provides developers to manage all their Transients with version management.

Installation

The preferred way to install this extension is through Composer.

To install WP_Transient_API library, simply:

$ composer require Varunsridharan/WP_Transient_API

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Varunsridharan/WP_Transient_API --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/varunsridharan/wp-transient-api.git

Or install it manually:

Download WP_Transient_API.php:

$ wget https://raw.githubusercontent.com/varunsridharan/wp-transient-api/master/class-transient-wp-api.php

Options

Option	Notes
WP Options API
option_prefix	Custom text to auto prefix for each option added via this class
option_surfix	Custom text to auto append for each option added via this class
option_version	On Which version the given option to be saved
option_auto_delete	if set to true then it auto deletes if the version dose not match
WP Transient API
transient_prefix	Custom text to auto prefix for each option added via this class
transient_surfix	Custom text to auto append for each option added via this class
transient_version	On Which version the given option to be saved
transient_auto_delete	if set to true then it auto deletes if the version dose not match

Usage

$api = new Varunsridharan\WordPress\Transient_API::instance('instance_key',array(
    // Transients
    'transient_version'     => 1.0,
    'transient_auto_delete' => false,
    'transient_surfix'      => '',
    'transient_prefix'      => '',
    // WP DB Options
    'option_auto_delete'    => false,
    'option_version'        => 1.0,
    'option_surfix'         => '',
    'option_prefix'         => '',
    // Global Config.
    'is_option'             => false,
));
YourPlugin_Transient_Api::instance();

Global Based On Class Settings

Note : update only works for if class set to wp options api

YourPlugin_Transient_Api::instance('instance_key')->set('your-key','your-value');
YourPlugin_Transient_Api::instance('instance_key')->get('your-key'); # Returns the values only if option version matched with $option_version
YourPlugin_Transient_Api::instance('instance_key')->update('your-key','your-value'); # Updates the options value
YourPlugin_Transient_Api::instance('instance_key')->delete('your-key'); # Deletes the options and its releated options 

WP Options API With Version Management

YourPlugin_Transient_Api::instance('instance_key')->add_option('your-key','your-value');
YourPlugin_Transient_Api::instance('instance_key')->get_option('your-key'); # Returns the values only if option version matched with $option_version
YourPlugin_Transient_Api::instance('instance_key')->update_option('your-key','your-value'); # Updates the options value
YourPlugin_Transient_Api::instance('instance_key')->delete_option('your-key'); # Deletes the options and its releated options 

WP Transient API With Version Management

YourPlugin_Transient_Api::instance('instance_key')->add_transient('your-key','your-value',2000);
YourPlugin_Transient_Api::instance('instance_key')->get_transient('your-key'); # Returns the values only if option version matched with $transient_version
YourPlugin_Transient_Api::instance('instance_key')->delete_transient('your-key'); # Deletes the options and its releated options 

---

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

• GNU General Public License v3.0 © Varun Sridharan
• Code of Conduct

📣 Feedback

• ⭐ This repository if this project helped you! 😉
• Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

• ☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
• ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
• 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
• 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

• Follow me on 👨‍💻 Github and stay updated on free and open-source software
• Follow me on 🐦 Twitter to get updates on my latest open source projects
• Message me on 📠 Telegram
• Follow my pet on Instagram for some dog-tastic updates!

---

Built With ♥ By Varun Sridharan

---