Skip to content
Simple WordPress URL Handler Ported To Javascript (add_query_arg,remove_query_arg)
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
functions
node_modules
.npmignore
LICENSE.md
README.md
config.js
gulpfile.js
index.js
package-lock.json
package.json
wordpress-js-ports.js

README.md

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="wordpress-js-ports.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

Contribute

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

License

This project is licensed under General Public License v3.0 license. See the LICENSE file for more info.

Copyright

2017 - 2018 Varun Sridharan, varunsridharan.in

If you find it useful, let me know 😉

You can contact me on Twitter or through my email.

Backed By

DigitalOcean JetBrains Tidio Chat
You can’t perform that action at this time.