Overview

Namespaces

  • Varunsridharan
    • WordPress

Classes

  • Endpoint
  • Overview
  • Namespace
  • Class

Class Endpoint

Class Endpoint

Namespace: Varunsridharan\WordPress
Package: Varunsridharan\WordPress
Author: Varun Sridharan varunsridharan23@gmail.com
Since: 1.0
Located at src/Endpoint.php
Methods summary
public
# __construct( string $prefix = '' )

Endpoint constructor.

Endpoint constructor.

Parameters

$prefix
Used to set prefeix for query args.
public
# prefix( string $prefix = '' )

Sets Prefix. Used to set prefeix for query args.

Sets Prefix. Used to set prefeix for query args.

Parameters

$prefix
public
# parse_request( $wp )

Parses Request And Triggers Callback / Action. Based On the $callback Arg when using add_endpoint()

Parses Request And Triggers Callback / Action. Based On the $callback Arg when using add_endpoint()

Parameters

$wp

Uses

\call_user_func()
\call_user_func_array()
public
# flush( )

Flushes WordPress's rewrite rules.

Flushes WordPress's rewrite rules.

public
# on_wp_init( )

On WP Init.

On WP Init.

protected
# register_rewrite_rules( )

Registers Rewrite Rules With WordPress.

Registers Rewrite Rules With WordPress.

protected
# register_rewrite_tags( )

Registers Rewrite Tag With WordPress.

Registers Rewrite Tag With WordPress.

protected
# register_rewrite_endpoints( )

Registers Rewrite Endpoints With WordPress.

Registers Rewrite Endpoints With WordPress.

public
# add_endpoint( string $endpoint = '', integer $endpoint_type = \EP_ROOT, array|string $callback = array() )

Adds Custom Endpoints To Endpoints Array.

Adds Custom Endpoints To Endpoints Array.

Parameters

$endpoint
$endpoint_type
$callback

Returns


$this

Example

add_endpoint('world/',EP_PAGES,array(&$this,'page_callback'))
add_endpoint('hello/',EP_PAGES,'my_page_calback')
public
# add_rewrite_rule( string $path = '', string $after = 'top' )

Adds Custom Rewrite Rules.

Adds Custom Rewrite Rules.

Parameters

$path
$after

Returns


$this
public
# add_tag( string $tag = '', string $regex = '', boolean $force = false )

Adds Rewrite Tag.

Adds Rewrite Tag.

Parameters

$tag
$regex
$force

Returns


$this
public array
# add_query_vars( array $vars = array() )

Adds Custom Query Vars TO WordPress.

Adds Custom Query Vars TO WordPress.

Parameters

$vars

Returns

array
Properties summary
public string $version

Version

Version

# '1.5'
protected array $rewrite_endpoint

Rewrite_endpoint

Rewrite_endpoint

# array()
protected array $rewrite_rule

Rewrite_rule

Rewrite_rule

# array()
protected array $rewrite_tag

Rewrite_tag

Rewrite_tag

# array()
protected string $rewrite_prefix
# 'wp_router'
protected string $parameter_pattern
# '/{([\w\d]+)}/'
protected string $value_pattern
# '(?P<$1>[^/]+)'
protected string $value_pattern_replace
# '([^\/]+)'
API documentation generated by ApiGen