varunsridharan/wp-endpoint

Simple Lib To Handle Creation of Custom Endpoints Or Rewrites in WordPress

Maintainers

Details

github.com/varunsridharan/wp-endpoint

Source

Issues

Fund package maintenance!
varunsridharan
paypal.me/varunsridharan23
www.buymeacoffee.com/varunsridharan

Installs: 44

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 2

Forks: 3

Open Issues: 1

1.5 2021-04-11 07:14 UTC

GPL-3.0-or-later cd9b9dc276f71f1a82ac7a62049fa63f5515c862

  • Varun <varunsridharan23.woop@gmail.com>

phpwordpresswordpress-pluginwordpress-developmentwordpress-librarywordpress-php-libraryrewriteswordpress-plugin-librarywordpress-pluginswordpress-plugin-developmentvsp-libswordpress-routerwordpress-plugin-addonwordpress-endpointwordpress-development-kitwp-endpoint

This package is auto-updated.

Last update: 2024-10-29 05:34:26 UTC

README

Simple Lib To Handle Creation of Custom Endpoints Or Rewrites in WordPress

Latest Stable Version Total Downloads Latest Unstable Version License composer.lock available

Installation

The preferred way to install this extension is through Composer.

To install WP_EndPoint library, simply:

$ composer require Varunsridharan/WP_Endpoint

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

You can also clone the complete repository with Git:

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

Or install it manually:

Download WP_Endpoint.php:

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

Usage

$vs_wp_endpoint = new \Varunsridharan\WordPress\Endpoint('customprefix');

Add End Point [ add_endpoint( $endpoint, $endpoint_type, $callback) ]

/**
 * Adds Custom Endpoints To Endpoints Array.
 *
 * @param string       $endpoint
 * @param int          $endpoint_type
 * @param array|string $callback 
 *                     if callback is a string and no function with the name then it will be triggered as action
 *
 * @example add_endpoint('hello/',EP_PAGES,'my_page_calback')
 * @example add_endpoint('world/',EP_PAGES,array(&$this,'page_callback'))
 *
 * @return $this
 */
 
 // With Action Trigger
 $vs_wp_endpoint->add_endpoint('myendpoint',EP_ROOT,'myendpoint_action');
 
 // With Function Callback
 $vs_wp_endpoint->add_endpoint('myendpoint2',EP_ROOT,'myendpoint_callback');
 
 // With Class Callback
 $vs_wp_endpoint->add_endpoint('myendpoint3',EP_ROOT,array('VS_CALLBACK_HANDLER','render'));


add_action('myendpoint_action','render_endpoint_page');

function render_endpoint_page($wp){
	var_dump($wp->query_vars);
}

function myendpoint_callback($wp){
	var_dump($wp->query_vars);
}

class VS_CALLBACK_HANDLER{
	public static function render($wp){
		echo 'Hi';
	}
}

Add Rewrite Rules [ add_rewrite_rule( $path, $after ) ]

/**
 * Adds Custom Rewrite Rules.
 *
 * @param string $path
 * @param string $after
 *
 * @return $this
 */
 
// Below Will Be Converted into **http://example.com/mypath/22/xxx/
$vs_wp_endpoint->add_rewrite_rule('mypath/{user_id}/{user_name}','top');

// Below Will Be Converted into **http://example.com/welcome/EICAUTPPWICAASJEJNCA/
$vs_wp_endpoint->add_rewrite_rule('welcome/{verify_id}','top');

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

Built With ā™„ By Varun Sridharan