wordpress-js-ports

This package ports from important functions from Core PHP WordPress into VanillaJS

Usage no npm install needed!

<script type="module">
  import wordpressJsPorts from 'https://cdn.skypack.dev/wordpress-js-ports';
</script>

README

WordPress JS Ports

NPM version Downloads

This Repository Contain's usefull WordPress URL PHP functions which are ported into Javascript to with minimal Dependency

Install

You Can install via NPM using below cmd

npm install wordpress-js-ports OR npm install wordpress-js-ports --save-dev

Manual

<script src="dist/wordpress-js-ports.min.js" type="text/javascript"/>

Ported Functions

  1. add_query_arg
  2. remove_query_arg
  3. trailingslashit
  4. untrailingslashit

add_query_arg

Retrieves a modified URL query string. You can rebuild the URL and append query variables to the URL query by using this function. There are two ways to use this function; either a single key and value, or an associative array.

Using a single key and value:

add_query_arg( 'key', 'value', 'http://example.com' );
// Output : http://example.com?key=value

Using an associative array:

add_query_arg( {
    'key1' : 'value1',
    'key2' : 'value2',
}, 'http://example.com' );
// Output : http://example.com?key1=value1&key2=value2

Omitting the URL from either use results in the current URL being used (the value of window.location.href).

remove_query_arg

Removes an item or items from a query string.

Using Single Key To Remove

add_query_arg( 'key1', 'http://example.com?key1=value1&key2=value2' );
//Output : http://example.com?key2=value2

Using An Array of Keys To Remove

add_query_arg( ['key1','key2'], 'http://example.com?key1=value1&key2=value2' );
//Output : http://example.com

trailingslashit

Appends a trailing slash.

Will remove trailing slash if it exists already before adding a trailing slash. This prevents double slashing a string or path.

The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.

trailingslashit( '/home/julien/bin/dotfiles' ); 
//Output : /home/julien/bin/dotfiles/

untrailingslashit

Removes trailing slash if it exists.

The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.

untrailingslashit( '/home/julien/bin/dotfiles/' ); 
//Output : /home/julien/bin/dotfiles

šŸ“ 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.

šŸ’° 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 ?

šŸ“œ License & Conduct

šŸ“£ Feedback

  • ā­ This repository if this project helped you! :wink:
  • Create An šŸ”§ Issue if you need help / found a bug

Connect & Say šŸ‘‹

Built With ā™„ By Varun Sridharan šŸ‡®šŸ‡³