183 lines
5.5 KiB
PHP
183 lines
5.5 KiB
PHP
<?php
|
|
/**
|
|
* Functions, which deal with URLs: manipulation, generation
|
|
*/
|
|
|
|
/**
|
|
* Returns the path of an URL.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $url Optional. The URL to parse. Defaults to GlotPress URL.
|
|
* @return string Path of the URL. Empty string if no path was parsed.
|
|
*/
|
|
function gp_url_path( $url = null ) {
|
|
if ( null === $url ) {
|
|
$url = gp_url();
|
|
}
|
|
|
|
$parsed = parse_url( $url );
|
|
return isset( $parsed['path'] ) ? $parsed['path'] : '';
|
|
}
|
|
|
|
/**
|
|
* Joins paths, and takes care of slashes between them.
|
|
*
|
|
* Example: gp_url_join( '/project', array( 'wp', 'dev) ) -> '/project/wp/dev'
|
|
*
|
|
* The function will keep leading and trailing slashes of the whole URL, but won't
|
|
* allow more than consecutive slash inside.
|
|
*
|
|
* @param mixed ...$components Arbitrary number of string or path components.
|
|
* @return string URL, built of all the components, separated with /.
|
|
*/
|
|
function gp_url_join( ...$components ) {
|
|
$components_in_flat_array = array_filter( gp_array_flatten( $components ) );
|
|
$components_with_slashes = implode( '/', $components_in_flat_array );
|
|
|
|
// Make sure all instances of the final URL are returned with a proper permalink ending.
|
|
$components_with_slashes = user_trailingslashit( $components_with_slashes );
|
|
|
|
$components_without_consecutive_slashes = preg_replace( '|/{2,}|', '/', $components_with_slashes );
|
|
$components_without_consecutive_slashes = str_replace( array( 'http:/', 'https:/' ), array( 'http://', 'https://' ), $components_without_consecutive_slashes );
|
|
return $components_without_consecutive_slashes;
|
|
}
|
|
|
|
/**
|
|
* Builds a URL relative to the GlotPress' domain root.
|
|
*
|
|
* @param mixed $path string path or array of path components
|
|
* @param array $query associative array of query arguments (optional)
|
|
*/
|
|
function gp_url( $path = '/', $query = null ) {
|
|
$base = gp_url_path( gp_url_public_root() );
|
|
$base = '/' . ltrim( $base, '/' ); // Make sure `$base` has always a leading slash.
|
|
|
|
/**
|
|
* Filter a URL relative to GlotPress' domain root.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $base The base path.
|
|
* @param string|array $path The GlotPress path or the components as an array.
|
|
* @param string $query The query part of the URL.
|
|
*/
|
|
return apply_filters( 'gp_url', gp_url_add_path_and_query( $base, $path, $query ), $path, $query );
|
|
}
|
|
|
|
function gp_url_add_path_and_query( $base, $path, $query ) {
|
|
// todo: same domain with current url?
|
|
$url = gp_url_join( $base, $path );
|
|
|
|
if ( $query && is_array( $query ) ) {
|
|
$url = add_query_arg( urlencode_deep( $query ), $url );
|
|
} elseif ( $query ) {
|
|
$url .= '?' . ltrim( $query, '?' );
|
|
}
|
|
|
|
/**
|
|
* Filter a GlotPress URL with path and query.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $url Generated URL.
|
|
* @param string $base The base path.
|
|
* @param array $path The GlotPress path or the components as an array.
|
|
* @param string $query The query part of the URL.
|
|
*/
|
|
return apply_filters( 'gp_url_add_path_and_query', $url, $base, $path, $query );
|
|
}
|
|
|
|
/**
|
|
* Retrieves the URL for the GlotPress root page.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return string GlotPress root page URL.
|
|
*/
|
|
function gp_url_public_root() {
|
|
return home_url( gp_url_base_path() );
|
|
}
|
|
|
|
/**
|
|
* Constructs URL for a project and locale.
|
|
* /<project-path>/<locale>/<path>/<page>
|
|
*/
|
|
function gp_url_project_locale( $project_or_path, $locale, $path = '', $query = null ) {
|
|
return gp_url_project( $project_or_path, array( $locale, $path ), $query );
|
|
}
|
|
|
|
/**
|
|
* Get the URL for an image file
|
|
*
|
|
* @param string $file Image filename
|
|
*
|
|
* @return string
|
|
*/
|
|
function gp_url_img( $file ) {
|
|
return gp_plugin_url( "assets/img/$file" );
|
|
}
|
|
|
|
/**
|
|
* The URL of the current page
|
|
*/
|
|
function gp_url_current() {
|
|
$protocol = is_ssl() ? 'https://' : 'http://';
|
|
$host = wp_unslash( gp_array_get( $_SERVER, 'HTTP_HOST' ) );
|
|
$path_and_args = wp_unslash( gp_array_get( $_SERVER, 'REQUEST_URI' ) );
|
|
|
|
return $protocol . $host . $path_and_args;
|
|
}
|
|
|
|
/**
|
|
* Get the URL for a project
|
|
*
|
|
* A leading double-slash will avoid prepending /projects/ to the path.
|
|
*
|
|
* @param GP_Project|string $project_or_path Project path or object.
|
|
* @param string|array $path Addition path to append to the base path.
|
|
* @param array $query Optional. Associative array of query arguments.
|
|
*
|
|
* @return string
|
|
*/
|
|
function gp_url_project( $project_or_path = '', $path = '', $query = null ) {
|
|
$project_path = is_object( $project_or_path ) ? $project_or_path->path : $project_or_path;
|
|
|
|
// A leading double-slash will avoid prepending /projects/ to the path.
|
|
// This was introduced to enable linking to the locale glossary.
|
|
if ( '//' === substr( $project_path, 0, 2 ) ) {
|
|
$project_path = ltrim( $project_path, '/' );
|
|
} else {
|
|
$project_path = array( 'projects', $project_path );
|
|
}
|
|
|
|
return gp_url( array( $project_path, $path ), $query );
|
|
}
|
|
|
|
function gp_url_profile( $user_nicename = '' ) {
|
|
$url = gp_url( array( '/profile', $user_nicename ) );
|
|
/**
|
|
* Filter the URL of a user profile.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $url The URL of the profile.
|
|
* @param string $user_nicename User's nicename; the slug of the user.
|
|
*/
|
|
return apply_filters( 'gp_url_profile', $url, $user_nicename );
|
|
}
|
|
|
|
function gp_url_base_path() {
|
|
/**
|
|
* Filter the base path of a GlotPress URL.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $url The url.
|
|
*/
|
|
return apply_filters( 'gp_url_base_path', user_trailingslashit( '/' . gp_const_get( 'GP_URL_BASE', 'glotpress' ) ) );
|
|
}
|
|
|
|
function gp_plugin_url( $path = '' ) {
|
|
return plugins_url( $path, GP_PLUGIN_FILE );
|
|
}
|
