class-ld-settings-section-support-templates.php
11.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<?php
/**
* LearnDash Settings Section for Support Templates Metabox.
*
* @since 3.1.0
* @package LearnDash\Settings\Sections
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ( class_exists( 'LearnDash_Settings_Section' ) ) && ( ! class_exists( 'LearnDash_Settings_Section_Support_Templates' ) ) ) {
/**
* Class LearnDash Settings Section for Support Templates Metabox.
*
* @since 3.1.0
*/
class LearnDash_Settings_Section_Support_Templates extends LearnDash_Settings_Section {
/**
* Settings set array for this section.
*
* @var array $settings_set Array of settings used by this section.
*/
protected $settings_set = array();
/**
* Settings template array for this section.
*
* @var array $template_array Array of template used by this section.
*/
protected $template_array = array();
/**
* Protected constructor for class
*
* @since 3.1.0
*/
protected function __construct() {
$this->settings_page_id = 'learndash_support';
// This is the 'option_name' key used in the wp_options table.
$this->setting_option_key = 'ld_templates';
// Used within the Settings API to uniquely identify this section.
$this->settings_section_key = 'settings_support_ld_templates';
// Section label/header.
$this->settings_section_label = esc_html__( 'Templates', 'learndash' );
$this->load_options = false;
add_filter( 'learndash_support_sections_init', array( $this, 'learndash_support_sections_init' ) );
add_action( 'learndash_section_fields_before', array( $this, 'show_support_section' ), 30, 2 );
parent::__construct();
}
/**
* Support Sections Init
*
* @since 3.1.0
*
* @param array $support_sections Support sections array.
*/
public function learndash_support_sections_init( $support_sections = array() ) {
global $wpdb, $wp_version, $wp_rewrite;
global $sfwd_lms;
$abspath_tmp = str_replace( '\\', '/', ABSPATH );
/************************************************************************************************
* Learndash Templates.
*/
if ( ! isset( $support_sections[ $this->setting_option_key ] ) ) {
$this->load_templates();
$this->settings_set = array();
$this->settings_set['header'] = array(
'html' => $this->settings_section_label,
'text' => $this->settings_section_label,
);
$this->settings_set['columns'] = array(
'label' => array(
'html' => esc_html__( 'Template Name', 'learndash' ),
'text' => 'Template Name',
'class' => 'learndash-support-settings-left',
),
'value' => array(
'html' => esc_html__( 'Template Path', 'learndash' ),
'text' => 'Template Path',
'class' => 'learndash-support-settings-right',
),
);
$this->settings_set['desc'] = '';
$this->settings_set['desc'] .= '<p><strong>' . esc_html__( 'Current Active LD Theme', 'learndash' ) . '</strong>: ' . LearnDash_Theme_Register::get_active_theme_name() . '</p>';
$template_paths = SFWD_LMS::get_template_paths( 'xxx.php' );
$theme_root = get_theme_root();
$theme_root = str_replace( '\\', '/', $theme_root );
$this->settings_set['desc'] .= '<p>' . esc_html__( 'The following is the search order paths for override templates, relative to site root:', 'learndash' );
$this->settings_set['desc'] .= '<ol>';
if ( ( isset( $template_paths['theme'] ) ) && ( ! empty( $template_paths['theme'] ) ) ) {
foreach ( $template_paths['theme'] as $theme_path ) {
$theme_path = dirname( $theme_path );
if ( '.' === $theme_path ) {
$theme_path = '';
} else {
$theme_path = '/' . $theme_path;
}
$this->settings_set['desc'] .= '<li>' . str_replace( $abspath_tmp, '/', $theme_root ) . '/' . esc_html__( '<PARENT or CHILD THEME>', 'learndash' ) . $theme_path . '</li>';
}
}
if ( ( isset( $template_paths['templates'] ) ) && ( ! empty( $template_paths['templates'] ) ) ) {
foreach ( $template_paths['templates'] as $theme_path ) {
$theme_path = dirname( $theme_path );
if ( '.' === $theme_path ) {
$theme_path = '';
}
$this->settings_set['desc'] .= '<li>' . str_replace( $abspath_tmp, '/', $theme_path ) . '</li>';
}
}
$this->settings_set['desc'] .= '</ol></p>';
$this->settings_set['settings'] = array();
$abspath_tmp = str_replace( '\\', '/', ABSPATH );
$learndash_lms_plugin_dir_tmp = str_replace( '\\', '/', LEARNDASH_LMS_PLUGIN_DIR );
if ( ! empty( $this->template_array ) ) {
foreach ( $this->template_array as $template_filename => $template_path ) {
if ( ! empty( $template_path ) ) {
$template_path = str_replace( '\\', '/', $template_path );
$this->settings_set['settings'][ $template_filename ] = array(
'label' => $template_filename,
);
if ( strncmp( $template_path, $learndash_lms_plugin_dir_tmp, strlen( $learndash_lms_plugin_dir_tmp ) ) != 0 ) {
$this->settings_set['settings'][ $template_filename ]['value_html'] = '<span style="color: red;">' . str_replace( $abspath_tmp, '', $template_path ) . '</span>';
$this->settings_set['settings'][ $template_filename ]['value'] = str_replace( $abspath_tmp, '', $template_path ) . ' (X)';
} else {
$this->settings_set['settings'][ $template_filename ]['value_html'] = str_replace( $abspath_tmp, '', $template_path );
$this->settings_set['settings'][ $template_filename ]['value'] = str_replace( $abspath_tmp, '', $template_path );
}
}
}
}
/** This filter is documented in includes/settings/settings-sections/class-ld-settings-section-support-database-tables.php */
$support_sections[ $this->setting_option_key ] = apply_filters( 'learndash_support_section', $this->settings_set, $this->setting_option_key );
}
return $support_sections;
}
/**
* Show Support Section
*
* @since 3.1.0
*
* @param string $settings_section_key Section Key.
* @param string $settings_screen_id Screen ID.
*/
public function show_support_section( $settings_section_key = '', $settings_screen_id = '' ) {
if ( $settings_section_key === $this->settings_section_key ) {
$support_page_instance = LearnDash_Settings_Page::get_page_instance( 'LearnDash_Settings_Page_Support' );
if ( $support_page_instance ) {
$support_page_instance->show_support_section( $this->setting_option_key );
}
}
}
/**
* Load template files in preparation for processing.
*
* @since 3.1.0
*/
public function load_templates() {
$this->template_array = array();
$abspath_tmp = str_replace( '\\', '/', ABSPATH );
$learndash_lms_plugin_dir_tmp = str_replace( '\\', '/', LEARNDASH_LMS_PLUGIN_DIR );
$active_theme_instance = LearnDash_Theme_Register::get_active_theme_instance();
if ( is_a( $active_theme_instance, 'LearnDash_Theme_Register' ) ) {
$active_theme_dir = $active_theme_instance->get_theme_template_dir();
$template_files = learndash_scandir_recursive( $active_theme_dir );
if ( ! empty( $template_files ) ) {
foreach ( $template_files as $idx => $template_file ) {
$template_file = str_replace( '\\', '/', $template_file );
$file_pathinfo = pathinfo( $template_file );
if ( ( ! isset( $file_pathinfo['extension'] ) ) || ( empty( $file_pathinfo['extension'] ) ) ) {
continue;
}
if ( ( ! isset( $file_pathinfo['filename'] ) ) || ( empty( $file_pathinfo['filename'] ) ) ) {
continue;
}
if ( ! in_array( $file_pathinfo['extension'], array( 'php', 'css', 'js' ), true ) ) {
continue;
}
if ( '_' === $file_pathinfo['filename'][0] ) {
continue;
}
if ( false !== strpos( $file_pathinfo['filename'], '.min.' ) ) {
continue;
}
if ( ! in_array( $template_file, $this->template_array, true ) ) {
$template_filename = str_replace( $active_theme_dir . '/', '', $template_file );
$template_path = SFWD_LMS::get_template( $template_filename, null, null, true );
if ( ! empty( $template_path ) ) {
$this->template_array[ $template_filename ] = $template_path;
}
}
}
}
}
if ( LearnDash_Theme_Register::get_active_theme_key() !== LEARNDASH_LEGACY_THEME ) {
$legacy_theme_instance = LearnDash_Theme_Register::get_theme_instance( LEARNDASH_LEGACY_THEME );
if ( is_a( $active_theme_instance, 'LearnDash_Theme_Register' ) ) {
$legacy_theme_dir = $legacy_theme_instance->get_theme_template_dir();
if ( ! empty( $legacy_theme_dir ) ) {
$template_files = learndash_scandir_recursive( $legacy_theme_dir );
if ( ! empty( $template_files ) ) {
foreach ( $template_files as $idx => $template_file ) {
$template_file = str_replace( '\\', '/', $template_file );
$file_pathinfo = pathinfo( $template_file );
if ( ( ! isset( $file_pathinfo['extension'] ) ) || ( empty( $file_pathinfo['extension'] ) ) ) {
continue;
}
if ( ( ! isset( $file_pathinfo['filename'] ) ) || ( empty( $file_pathinfo['filename'] ) ) ) {
continue;
}
if ( ! in_array( $file_pathinfo['extension'], array( 'php', 'css', 'js' ), true ) ) {
continue;
}
if ( '_' === $file_pathinfo['filename'][0] ) {
continue;
}
if ( false !== strpos( $file_pathinfo['filename'], '.min.' ) ) {
continue;
}
$template_filename = str_replace( $legacy_theme_dir . '/', '', $template_file );
if ( ! isset( $this->template_array[ $template_filename ] ) ) {
$template_path = SFWD_LMS::get_template( $template_filename, null, null, true );
if ( ! empty( $template_path ) ) {
$this->template_array[ $template_filename ] = $template_path;
}
}
}
}
}
}
}
if ( ! empty( $this->template_array ) ) {
ksort( $this->template_array );
// We want to reorder the.
$templates_grouped = array(
'override' => array(),
);
$active_theme_dir = '';
$legacy_theme_dir = '';
$active_theme_instance = LearnDash_Theme_Register::get_active_theme_instance();
if ( is_a( $active_theme_instance, 'LearnDash_Theme_Register' ) ) {
$templates_grouped['active'] = array();
$active_theme_dir = $active_theme_instance->get_theme_template_dir();
}
if ( LearnDash_Theme_Register::get_active_theme_key() !== LEARNDASH_LEGACY_THEME ) {
$legacy_theme_instance = LearnDash_Theme_Register::get_theme_instance( LEARNDASH_LEGACY_THEME );
if ( is_a( $active_theme_instance, 'LearnDash_Theme_Register' ) ) {
$templates_grouped['legacy'] = array();
$legacy_theme_dir = $legacy_theme_instance->get_theme_template_dir();
}
}
foreach ( $this->template_array as $template_filename => $template_path ) {
if ( strncmp( $template_path, $learndash_lms_plugin_dir_tmp, strlen( $learndash_lms_plugin_dir_tmp ) ) != 0 ) {
$templates_grouped['override'][ $template_filename ] = $template_path;
} elseif ( ( ! empty( $active_theme_dir ) ) && ( strncmp( $template_path, $active_theme_dir, strlen( $active_theme_dir ) ) == 0 ) ) {
$templates_grouped['active'][ $template_filename ] = $template_path;
} elseif ( ( ! empty( $legacy_theme_dir ) ) && ( strncmp( $template_path, $legacy_theme_dir, strlen( $legacy_theme_dir ) ) == 0 ) ) {
$templates_grouped['legacy'][ $template_filename ] = $template_path;
}
}
$this->template_array = array();
foreach ( $templates_grouped as $template_section => $template_array ) {
if ( ! empty( $template_array ) ) {
$this->template_array = array_merge( $this->template_array, $template_array );
}
}
}
}
// End of functions.
}
}
add_action(
'learndash_settings_sections_init',
function() {
LearnDash_Settings_Section_Support_Templates::add_section_instance();
}
);