-
-
Notifications
You must be signed in to change notification settings - Fork 513
/
Menu.php
356 lines (318 loc) · 8.52 KB
/
Menu.php
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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
namespace Timber;
use Timber\Core;
use Timber\Post;
class Menu extends Term {
public $MenuItemClass = 'Timber\MenuItem';
public $PostClass = 'Timber\Post';
/**
* @api
* @var integer The depth of the menu we are rendering
*/
public $depth;
/**
* @api
* @var array|null Array of `Timber\Menu` objects you can to iterate through.
*/
public $items = null;
/**
* @api
* @var integer The ID of the menu, corresponding to the wp_terms table.
*/
public $id;
/**
* @api
* @var integer The ID of the menu, corresponding to the wp_terms table.
*/
public $ID;
/**
* @api
* @var integer The ID of the menu, corresponding to the wp_terms table.
*/
public $term_id;
/**
* @api
* @var string The name of the menu (ex: `Main Navigation`).
*/
public $name;
/**
* @api
* @var string The name of the menu (ex: `Main Navigation`).
*/
public $title;
/**
* Menu options.
*
* @api
* @since 1.9.6
* @var array An array of menu options.
*/
public $options;
/**
* @api
* @var array The unfiltered options sent forward via the user in the __construct
*/
public $raw_options;
/**
* Theme Location.
*
* @api
* @since 1.9.6
* @var string The theme location of the menu, if available.
*/
public $theme_location = null;
/**
* Initialize a menu.
*
* @param int|string $slug A menu slug, the term ID of the menu, the full name from the admin
* menu, the slug of the registered location or nothing. Passing
* nothing is good if you only have one menu. Timber will grab what
* it finds.
* @param array $options Optional. An array of options. Right now, only the `depth` is
* supported which says how many levels of hierarchy should be
* included in the menu. Default `0`, which is all levels.
*/
public function __construct( $slug = 0, $options = array() ) {
$menu_id = false;
$locations = get_nav_menu_locations();
// For future enhancements?
$this->raw_options = $options;
$this->options = wp_parse_args( (array) $options, array(
'depth' => 0,
) );
$this->depth = (int) $this->options['depth'];
if ( $slug != 0 && is_numeric($slug) ) {
$menu_id = $slug;
} else if ( is_array($locations) && ! empty( $locations ) ) {
$menu_id = $this->get_menu_id_from_locations($slug, $locations);
} else if ( $slug === false ) {
$menu_id = false;
}
if ( !$menu_id ) {
$menu_id = $this->get_menu_id_from_terms($slug);
}
if ( $menu_id ) {
$this->init($menu_id);
} else {
$this->init_as_page_menu();
}
}
/**
* @internal
* @param int $menu_id
*/
protected function init( $menu_id ) {
$menu = wp_get_nav_menu_items($menu_id);
$locations = get_nav_menu_locations();
// Set theme location if available.
if ( ! empty( $locations ) && in_array( $menu_id, $locations, true ) ) {
$this->theme_location = array_search( $menu_id, $locations, true );
}
if ( $menu ) {
_wp_menu_item_classes_by_context($menu);
if ( is_array($menu) ) {
/**
* Default arguments from wp_nav_menu() function.
*
* @see wp_nav_menu()
*/
$default_args_array = array(
'menu' => '',
'container' => 'div',
'container_class' => '',
'container_id' => '',
'menu_class' => 'menu',
'menu_id' => '',
'echo' => true,
'fallback_cb' => 'wp_page_menu',
'before' => '',
'after' => '',
'link_before' => '',
'link_after' => '',
'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',
'item_spacing' => 'preserve',
'depth' => $this->depth,
'walker' => '',
'theme_location' => '',
);
/**
* Improve compatibitility with third-party plugins.
*
* @see wp_nav_menu()
*/
$default_args_array = apply_filters( 'wp_nav_menu_args', $default_args_array );
$default_args_obj = (object) $default_args_array;
$menu = apply_filters( 'wp_nav_menu_objects', $menu, $default_args_obj );
$menu = self::order_children($menu);
$menu = self::strip_to_depth_limit($menu);
}
$this->items = $menu;
$menu_info = wp_get_nav_menu_object($menu_id);
$this->import($menu_info);
$this->ID = $this->term_id;
$this->id = $this->term_id;
$this->title = $this->name;
}
}
/**
* @internal
*/
protected function init_as_page_menu() {
$menu = get_pages(array('sort_column' => 'menu_order'));
if ( $menu ) {
foreach ( $menu as $mi ) {
$mi->__title = $mi->post_title;
}
_wp_menu_item_classes_by_context($menu);
if ( is_array($menu) ) {
$menu = self::order_children($menu);
}
$this->items = $menu;
}
}
/**
* @internal
* @param string $slug
* @param array $locations
* @return integer
*/
protected function get_menu_id_from_locations( $slug, $locations ) {
if ( $slug === 0 ) {
$slug = $this->get_menu_id_from_terms($slug);
}
if ( is_numeric($slug) ) {
$slug = array_search($slug, $locations);
}
if ( isset($locations[$slug]) ) {
$menu_id = $locations[$slug];
if ( function_exists('wpml_object_id_filter') ) {
$menu_id = wpml_object_id_filter($locations[$slug], 'nav_menu');
}
return $menu_id;
}
}
/**
* @internal
* @param int $slug
* @return int
*/
protected function get_menu_id_from_terms( $slug = 0 ) {
if ( !is_numeric($slug) && is_string($slug) ) {
//we have a string so lets search for that
$menu = get_term_by('slug', $slug, 'nav_menu');
if ( $menu ) {
return $menu->term_id;
}
$menu = get_term_by('name', $slug, 'nav_menu');
if ( $menu ) {
return $menu->term_id;
}
}
$menus = get_terms('nav_menu', array('hide_empty' => true));
if ( is_array($menus) && count($menus) ) {
if ( isset($menus[0]->term_id) ) {
return $menus[0]->term_id;
}
}
return 0;
}
/**
* Find a parent menu item in a set of menu items.
*
* @api
* @param array $menu_items An array of menu items.
* @param int $parent_id The parent ID to look for.
* @return \Timber\MenuItem|bool A menu item. False if no parent was found.
*/
public function find_parent_item_in_menu( $menu_items, $parent_id ) {
foreach ( $menu_items as &$item ) {
if ( $item->ID == $parent_id ) {
return $item;
}
}
}
/**
* @internal
* @param array $items
* @return array
*/
protected function order_children( $items ) {
$index = array();
$menu = array();
$wp_post_menu_item = null;
foreach ( $items as $item ) {
if ( isset($item->title) ) {
// Items from WordPress can come with a $title property which conflicts with methods
$item->__title = $item->title;
unset($item->title);
}
if ( isset($item->ID) ) {
if ( is_object($item) && get_class($item) == 'WP_Post' ) {
$wp_post_menu_item = $item;
$item = new $this->PostClass($item);
}
$menu_item = $this->create_menu_item($item);
if ( $wp_post_menu_item ) {
$menu_item->import_classes($wp_post_menu_item);
}
$wp_post_menu_item = null;
$index[$item->ID] = $menu_item;
}
}
foreach ( $index as $item ) {
if ( isset($item->menu_item_parent) && $item->menu_item_parent && isset($index[$item->menu_item_parent]) ) {
$index[$item->menu_item_parent]->add_child($item);
} else {
$menu[] = $item;
}
}
return $menu;
}
/**
* @internal
* @param object $item the WP menu item object to wrap
* @return mixed an instance of the user-configured $MenuItemClass
*/
protected function create_menu_item($item) {
return new $this->MenuItemClass( $item, $this );
}
/**
* @internal
* @param array $menu
*/
protected function strip_to_depth_limit ($menu, $current = 1) {
$depth = (int)$this->depth; // Confirms still int.
if ($depth <= 0) {
return $menu;
}
foreach ($menu as &$currentItem) {
if ($current == $depth) {
$currentItem->children = false;
continue;
}
$currentItem->children = self::strip_to_depth_limit($currentItem->children, $current + 1);
}
return $menu;
}
/**
* Get menu items.
*
* Instead of using this function, you can use the `$items` property directly to get the items
* for a menu.
*
* @api
* @example
* ```twig
* {% for item in menu.get_items %}
* <a href="{{ item.link }}">{{ item.title }}</a>
* {% endfor %}
* ```
* @return array Array of `Timber\MenuItem` objects. Empty array if no items could be found.
*/
public function get_items() {
if ( is_array( $this->items ) ) {
return $this->items;
}
return array();
}
}