Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added a function to fetch all of the path define tokens that may be present in template paths

This commit is contained in:
Christopher Allford 2020-04-05 13:07:49 -07:00
parent 33e81654a9
commit a7c0dec33a
2 changed files with 38 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
includes/wc-core-functions.php
View File

@ -205,6 +205,31 @@ function wc_untokenize_path( $path, $path_tokens ) {
return $path;
}
/**
* Fetches an array containing all of the configurable path constants to be used in tokenization.
*
* @return array The key is the define and the path is the constant.
*/
function wc_get_path_define_tokens() {
$defines = array(
'ABSPATH',
'WC_ABSPATH',
'WP_CONTENT_DIR',
'WP_PLUGIN_DIR',
'PLUGINDIR',
'WP_THEME_DIR',
);
$path_tokens = array();
foreach ( $defines as $define ) {
if ( defined( $define ) ) {
$path_tokens[ $define ] = constant( $define );
}
}
return apply_filters( 'wc_get_path_define_tokens', $path_tokens );
}
/**
* Get template part (for templates like the shop-loop).
*
@ -243,22 +268,12 @@ function wc_get_template_part( $slug, $name = '' ) {
}
// Don't cache the absolute path so that it can be shared between web servers with different paths.
$cache_path = wc_tokenize_path(
$template,
array(
'ABSPATH' => ABSPATH,
)
);
$cache_path = wc_tokenize_path( $template, wc_get_path_define_tokens() );
wp_cache_set( $cache_key, $cache_path, 'woocommerce' );
} else {
// Make sure that the absolute path to the template is resolved.
$template = wc_untokenize_path(
$template,
array(
'ABSPATH' => ABSPATH,
)
);
$template = wc_untokenize_path( $template, wc_get_path_define_tokens() );
}
// Allow 3rd party plugins to filter template file from their plugin.
@ -285,22 +300,12 @@ function wc_get_template( $template_name, $args = array(), $template_path = '',
$template = wc_locate_template( $template_name, $template_path, $default_path );
// Don't cache the absolute path so that it can be shared between web servers with different paths.
$cache_path = wc_tokenize_path(
$template,
array(
'ABSPATH' => ABSPATH,
)
);
$cache_path = wc_tokenize_path( $template, wc_get_path_define_tokens() );
wp_cache_set( $cache_key, $cache_path, 'woocommerce' );
} else {
// Make sure that the absolute path to the template is resolved.
$template = wc_untokenize_path(
$template,
array(
'ABSPATH' => ABSPATH,
)
);
$template = wc_untokenize_path( $template, wc_get_path_define_tokens() );
}
// Allow 3rd party plugin filter template file from their plugin.

9
tests/unit-tests/util/class-wc-tests-core-functions.php
View File

@ -635,6 +635,15 @@ class WC_Tests_Core_Functions extends WC_Unit_Test_Case {
$this->assertEquals( WP_CONTENT_DIR . 'test', $path );
}
/**
* Tests the wc_get_path_define_tokens function.
*/
public function test_wc_get_path_define_tokens() {
$defines = wc_get_path_define_tokens();
$this->assertArrayHasKey( 'ABSPATH', $defines );
$this->assertEquals( ABSPATH, $defines['ABSPATH'] );
}
/**
* Test wc_get_template.
*