WPDKWordPressPaths Class Reference

Static Public Member Functions
static	homeURL ($blog_id=null, $path= '', $scheme=null)
	Home URL. More...
static	adminURL ($blog_id=null, $path= '', $scheme= 'admin')
	Admin URL. More...
static	includesURL ($path= '')
	Includes URL. More...
static	pluginsURL ($path= '', $plugin= '')
	Plugins URL. More...

Detailed Description

This class allow to access to the WordPress and WPDK standard path and URI. All path and URL are auto termianted with "/" slash.

Author

=undo= info@.nosp@m.wpxt.nosp@m.re.me

Copyright

Copyright (C) 2012-2013 wpXtreme Inc. All Rights Reserved.

Date

2012-11-28

Version

0.8.1

Note

Please visit http://codex.wordpress.org/Determining_Plugin_and_Content_Directories before add any methods

Definition at line 959 of file wpdk-wordpress-plugin.php.

Member Function Documentation

static adminURL (   $blog_id = null,   $path = '',   $scheme = 'admin'  )

static

Admin URL.

Retrieve the url to the admin area for a given site.

Parameters

int	$blog_id	(optional) Blog ID. Defaults to current blog.
string	$path	Optional path relative to the admin url.
string	$scheme	The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

Returns

string Admin url link with optional path appended.

Definition at line 992 of file wpdk-wordpress-plugin.php.

static homeURL (   $blog_id = null,   $path = '',   $scheme = null  )

static

Home URL.

Retrieve the home url for a given site.

Returns the 'home' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

Parameters

int	$blog_id	(optional) Blog ID. Defaults to current blog.
string	$path	(optional) Path relative to the home url.
string	$scheme	(optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.

Returns

string Home url link with optional path appended.

Definition at line 976 of file wpdk-wordpress-plugin.php.

static includesURL (   $path = '' )

static

Includes URL.

Retrieve the url to the includes directory.

Parameters

string

$path

Optional. Path relative to the includes url.

Returns

string Includes url link with optional path appended.

Definition at line 1006 of file wpdk-wordpress-plugin.php.

static pluginsURL (   $path = '',   $plugin = ''  )

static

Plugins URL.

Retrieve the url to the plugins directory or to a specific file within that directory. You can hardcode the plugin slug in $path or pass FILE as a second argument to get the correct folder name.

Parameters

string	$path	Optional. Path relative to the plugins url.
string	$plugin	Optional. The plugin file that you want to be relative to - i.e. pass in FILE

Returns

string Plugins url link with optional path appended.

Definition at line 1022 of file wpdk-wordpress-plugin.php.

---

The documentation for this class was generated from the following file:

• classes/core/wpdk-wordpress-plugin.php