Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/varunsridharan/wp-localizer

Simple & Usefull WP Localizer Library
https://github.com/varunsridharan/wp-localizer

vsp-libs wordpress wordpress-development wordpress-js-helpers wordpress-js-utilites wordpress-localization wordpress-plugin wordpress-plugin-api wordpress-plugin-library wordpress-theme wordpress-theme-library wp-library

Last synced: about 2 months ago
JSON representation

Simple & Usefull WP Localizer Library

Host: GitHub
URL: https://github.com/varunsridharan/wp-localizer
Owner: varunsridharan
License: gpl-3.0
Created: 2019-04-26T01:35:07.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2021-04-29T19:35:50.000Z (over 3 years ago)
Last Synced: 2024-10-10T02:22:03.020Z (3 months ago)
Topics: vsp-libs, wordpress, wordpress-development, wordpress-js-helpers, wordpress-js-utilites, wordpress-localization, wordpress-plugin, wordpress-plugin-api, wordpress-plugin-library, wordpress-theme, wordpress-theme-library, wp-library
Language: PHP
Homepage: https://varunsridharan.github.io/wp-localizer/
Size: 111 KB
Stars: 1
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # WP Localizer

Simple & Useful WP Localizer Library For Plugins / Themes

[![Latest Stable Version][latest-stable-version-img]][latest-stable-version-link]

[![Latest Unstable Version][latest-Unstable-version-img]][latest-Unstable-version-link]

[![Total Downloads][total-downloads-img]][total-downloads-link]

[![WP][wpcs-img]][wpcs-link]

[![License][license-img]][license-link]

[![composer.lock available][composerlock-img]][composerlock-link]

## Installation

The preferred way to install this extension is through [Composer][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][downloadphp]:

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

## Options

| Option Name | Value | Description |

| --- | --- | --- |

| `id` |  String | Unique ID it should be a **slug** |

| `scripts` | Array |  An Array of script handles to check before localizing the data  |

| `frontend` | true / false |  Load in frontend ? ( By default it loads only in wp-admin )

| `functions` | true / false |  Create useful JS Functions for getting values that are localized

### 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

 '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

```javascript

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](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[Checkout CHANGELOG.md](https://github.com/varunsridharan/wp-localizer/blob/main/CHANGELOG.md)

## 🤝 Contributing

If you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/wp-localizer/issues/).

## 📜  License & Conduct

- [**GNU General Public License v3.0**](https://github.com/varunsridharan/wp-localizer/blob/main/LICENSE) © [Varun Sridharan](website)

- [Code of Conduct](https://github.com/varunsridharan/.github/blob/main/CODE_OF_CONDUCT.md)

## 📣 Feedback

- ⭐ This repository if this project helped you! :wink:

- Create An [🔧 Issue](https://github.com/varunsridharan/wp-localizer/issues/) if you need help / found a bug

## 💰 Sponsor

[I][twitter] fell in love with open-source in 2013 and there has been no looking back since! You can read more about me [here][website].

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**][buymeacoffee]

- ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]

- 🔰         We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]

- 🚀         Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]

[paypal]: https://sva.onl/paypal

[buymeacoffee]: https://sva.onl/buymeacoffee

[twitter]: https://sva.onl/twitter/

[website]: https://sva.onl/website/

## Connect & Say 👋

- **Follow** me on [👨‍💻 Github][github] and stay updated on free and open-source software

- **Follow** me on [🐦 Twitter][twitter] to get updates on my latest open source projects

- **Message** me on [📠 Telegram][telegram]

- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!

[sofythelabrador]: https://www.instagram.com/sofythelabrador/

[github]: https://sva.onl/github/

[twitter]: https://sva.onl/twitter/

[telegram]: https://sva.onl/telegram/

---



Built With ♥ By Varun Sridharan 

     



   



---

[composer]: http://getcomposer.org/download/

[downloadphp]:https://raw.githubusercontent.com/varunsridharan/wp-localizer/master/src/Localizer.php

[latest-stable-version-img]: https://poser.pugx.org/varunsridharan/wp-localizer/version

[latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp-localizer/v/unstable

[total-downloads-img]: https://poser.pugx.org/varunsridharan/wp-localizer/downloads

[Latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp-localizer/v/unstable

[wpcs-img]: https://img.shields.io/badge/WordPress-Standar-1abc9c.svg

[license-img]: https://poser.pugx.org/varunsridharan/wp-localizer/license

[composerlock-img]: https://poser.pugx.org/varunsridharan/wp-localizer/composerlock

[latest-stable-version-link]: https://packagist.org/packages/varunsridharan/wp-localizer

[latest-Unstable-version-link]: https://packagist.org/packages/varunsridharan/wp-localizer

[total-downloads-link]: https://packagist.org/packages/varunsridharan/wp-localizer

[Latest-Unstable-Version-link]: https://packagist.org/packages/varunsridharan/wp-localizer

[wpcs-link]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/

[license-link]: https://packagist.org/packages/varunsridharan/wp-localizer

[composerlock-link]: https://packagist.org/packages/varunsridharan/wp-localizer