README

Simple & Useful WP Localizer Library For Plugins / Themes

Installation

The preferred way to install this extension is through Composer.

To install WP_Localizer library, simply:

$ composer require varunsridharan/wp-localizer

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-localizer --prefer-source

You can also clone the complete repository with Git:

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

Or install it manually:

Download Localizer.php:

$ wget https://raw.githubusercontent.com/varunsridharan/wp-localizer/master/src/Localizer.php

Options

Javascript Functions

if functions arg is set to true then 2 javascript functions are generated

{id}_option -- Function to get arguments passed from php Eg : (myplugin_option('object2''));
{id}_txt -- Function to get translated string passed from php Eg : (`myplugin_txt('some_title','Default Title'));

Usage

<?php
/**
 * Create A New Instance
 */
$instance = \Varunsridharan\WordPress\Localizer::instance( array(
    'id'        => 'myplugin',
    'scripts'   => array( 'my-plugin-script' ),
    'frontend'  => true,
    'functions' => true,
) );

/**
 * Get Existing Instance
 */
$instance_existing = \Varunsridharan\WordPress\Localizer::instance( 'myplugin' );

$instance->add( 'alert_info', array(
    'show' => false # It can be Array / String / Bool / Int
) );

$instance->add( 'object2', 'Some Value'/* It can be Array / String / Bool / Int */ );

/**
 * Merges With Existing object1 value.
 */
$instance->add( 'alet_info', array(
	'title' => 'Some Value',
), true );

// Translation.
$instance->text('alert_title',__('Your Alert Title'));

Javascript Usage

var $arg = myplugin_option( 'alert_info' );
if(true === $arg.show){
	alert($arg.title);
}
alert(myplugin_txt('alert_title','Default Title Here'));

⚠️ Note myplugin_option AND myplugin_txt javascript functions are created dynamically

📝 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

📣 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

varunsridharan / wp-localizer

Maintainers

Details