Docs for page wpRedirect.php

Description

wpRedirect: Advanced WordPress post and page redirection plugin.

Allows editors to redirect posts or pages to alternate URLs by simply adding a WordPress custom field to their entry. Uses caching if available. Developers can also use the wpRedirect($url) function in their own code.

version: 1.1
see: http://tekartist.org/labs/wordpress/plugins/wpredirect/
filesource: Source Code for this file
license: GPL

Constants

WPREDIRECT_CACHE_FLAG = 'wpRedirect' (line 46)

Name of the dedicated wpRedirect cache flag/directory

WPREDIRECT_CACHE_TTL = 31536000 (line 51)

Cache time to live (TTL) [365 days]

WPREDIRECT_DEFAULT_META = 'redirect_me' (line 56)

Default WordPress custom field key name.

usedby: wpRedirect_optionsPanel()
usedby: wpRedirect_metaKey()

Functions

wpRedirect (line 64)

Safe and convenient redirection mechanism.

return: false | exit
usedby: wpRedirect_init()

boolean wpRedirect (string $url)

string $url: Fully qualified URL or local path web to redirect to.

wpRedirect_addMenu (line 237)

Adds the Menu for Wordpress Admin Panel.

Used in add_action('admin_menu', 'wpDirAuth_addmenu');

uses: wpRedirect_optionsPanel()

void wpRedirect_addMenu ()

wpRedirect_getAndCache (line 139)

Gets, caches and returns the actual URL to be redirected to.

return: false | string URL to redirect to
usedby: wpRedirect_init()
uses: wpRedirect_metaKey()
uses: WPREDIRECT_CACHE_TTL
uses: WPREDIRECT_CACHE_FLAG

boolean wpRedirect_getAndCache (integer $post_ID)

integer $post_ID: An existing WP post/page ID

wpRedirect_init (line 164)

wpRedirect wrapper for WordPress add_action(); checks if post is single or page, tries to get content of `redirect_me` custom field, then redirects if necessary.

void wpRedirect_init ()

wpRedirect_metaKey (line 110)

Gets the appropriate WP post meta key to to retrieve the redirect url.

return: Custom or default field key name.
usedby: wpRedirect_optionsPanel()
usedby: wpRedirect_getAndCache()
uses: WPREDIRECT_DEFAULT_META
uses: WPREDIRECT_CACHE_TTL
uses: WPREDIRECT_CACHE_FLAG

string wpRedirect_metaKey ()

wpRedirect_optionsPanel (line 190)

wpRedirect plugin configuration panel.

Allows administrators to define their own WP custom field to scan for redirects.

void wpRedirect_optionsPanel ()

/wpRedirect.php