forked from amereservant/PHP-Hooks
-
Notifications
You must be signed in to change notification settings - Fork 17
/
Hooks.php
1136 lines (1003 loc) · 31 KB
/
Hooks.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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace voku\helper;
/**
* PHP Hooks Class (Modified)
*
* The PHP Hooks Class is a fork of the WordPress filters hook system rolled in
* to a class to be ported into any php based system
*
* This class is heavily based on the WordPress plugin API and most (if not all)
* of the code comes from there.
*
* @copyright 2011 - 2016
* @author Ohad Raz <admin@bainternet.info>
* @link http://en.bainternet.info
* @author David Miles <david@amereservant.com>
* @link http://github.com/amereservant/PHP-Hooks
* @author Lars Moelleken <lars@moelleken.org>
* @link https://github.com/voku/PHP-Hooks/
* @author Damien "Mistic" Sorel <contact@git.strangeplanet.fr>
* @link http://www.strangeplanet.fr
*
* @license GNU General Public License v3.0 - license.txt
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package voku\helper
*/
class Hooks
{
/**
* Filters - holds list of hooks
*
* @var array
* @access protected
* @since 1.0.0
*/
protected $filters = array();
/**
* Merged Filters
*
* @var array
* @access protected
* @since 1.0.0
*/
protected $merged_filters = array();
/**
* Actions
*
* @var array
* @access protected
* @since 1.0.0
*/
protected $actions = array();
/**
* Current Filter - holds the name of the current filter
*
* @var array
* @access protected
* @since 1.0.0
*/
protected $current_filter = array();
/**
* Container for storing shortcode tags and their hook to call for the shortcode
*
* @since 1.0.0
* @name $shortcode_tags
* @var array
*/
public static $shortcode_tags = array();
/**
* Default priority
*
* @since 0.2
* @const int
*/
const PRIORITY_NEUTRAL = 50;
/**
* is not allowed to call from outside: private!
*
* @access private
*/
protected function __construct()
{
}
/**
* prevent the instance from being cloned
*
* @access private
*
* @return void
*/
protected function __clone()
{
}
/**
* Singleton Instance
*
* Returns a Singleton instance of this class.
*
* @param void
*
* @return Hooks
* @access public
* @static
* @since 1.0.0
*/
public static function getInstance()
{
static $instance;
if (null === $instance) {
$instance = new self();
}
return $instance;
}
/**
* FILTERS
*/
/**
* Adds Hooks to a function or method to a specific filter action.
*
* @access public
* @since 1.0.0
*
* @param string $tag The name of the filter to hook the
* {@link $function_to_add} to.
* @param string $function_to_add The name of the function to be called
* when the filter is applied.
* @param integer $priority (optional) Used to specify the order in
* which the functions associated with a
* particular action are executed (default: 50).
* Lower numbers correspond with earlier execution,
* and functions with the same priority are executed
* in the order in which they were added to the action.
* @param string $include_path optional. File to include before executing the callback.
*
* @return boolean true
*/
public function add_filter($tag, $function_to_add, $priority = self::PRIORITY_NEUTRAL, $include_path = null)
{
$idx = $this->__filter_build_unique_id($function_to_add);
$this->filters[$tag][$priority][$idx] = array(
'function' => $function_to_add,
'include_path' => is_string($include_path) ? $include_path : null,
);
unset($this->merged_filters[$tag]);
return true;
}
/**
* Removes a function from a specified filter hook.
*
* @param string $tag the filter hook to which the function to be removed is hooked.
* @param mixed $function_to_remove the name of the function which should be removed.
* @param int $priority (optional) The priority of the function (default: 50).
*
* @return bool
*/
public function remove_filter($tag, $function_to_remove, $priority = self::PRIORITY_NEUTRAL)
{
$function_to_remove = $this->__filter_build_unique_id($function_to_remove);
if (!isset($this->filters[$tag][$priority][$function_to_remove])) {
return false;
}
unset($this->filters[$tag][$priority][$function_to_remove]);
if (empty($this->filters[$tag][$priority])) {
unset($this->filters[$tag][$priority]);
}
unset($this->merged_filters[$tag]);
return true;
}
/**
* Remove all of the hooks from a filter.
*
* @param string $tag the filter to remove hooks from.
* @param bool $priority the priority number to remove.
*
* @return bool True when finished.
*/
public function remove_all_filters($tag, $priority = false)
{
if (isset($this->merged_filters[$tag])) {
unset($this->merged_filters[$tag]);
}
if (!isset($this->filters[$tag])) {
return true;
}
if (false !== $priority && isset($this->filters[$tag][$priority])) {
unset($this->filters[$tag][$priority]);
} else {
unset($this->filters[$tag]);
}
return true;
}
/**
* Check if any filter has been registered for the given hook.
*
* Info: Use !== false to check if it's true!
*
* @param string $tag the name of the filter hook.
* @param bool $function_to_check callback function name to check for. [optional]
*
* @return mixed If {@link $function_to_check} is omitted,
* returns boolean for whether the hook has
* anything registered.
* When checking a specific function, the priority
* of that hook is returned, or false if the
* function is not attached.
* When using the {@link $function_to_check} argument,
* this function may return a non-boolean value that
* evaluates to false
* (e.g.) 0, so use the === operator for testing the return value.
* @access public
* @since 1.0.0
*/
public function has_filter($tag, $function_to_check = false)
{
$has = isset($this->filters[$tag]);
if (false === $function_to_check || !$has) {
return $has;
}
if (!($idx = $this->__filter_build_unique_id($function_to_check))) {
return false;
}
foreach ((array)array_keys($this->filters[$tag]) as $priority) {
if (isset($this->filters[$tag][$priority][$idx])) {
return $priority;
}
}
return false;
}
/**
* Call the functions added to a filter hook.
*
* Info: Additional variables passed to the functions hooked to <tt>$tag</tt>.
*
* @param string $tag The name of the filter hook.
* @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
*
* @return mixed The filtered value after all hooked functions are applied to it.
* @access public
* @since 1.0.0
*/
public function apply_filters($tag, $value)
{
$args = array();
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$args = func_get_args();
$this->__call_all_hook($args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return $value;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
if (empty($args)) {
$args = func_get_args();
}
array_shift($args);
do {
foreach ((array)current($this->filters[$tag]) as $the_) {
if (null !== $the_['function']) {
if (null !== $the_['include_path']) {
/** @noinspection PhpIncludeInspection */
include_once $the_['include_path'];
}
$args[0] = $value;
$value = call_user_func_array($the_['function'], $args);
}
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return $value;
}
/**
* Execute functions hooked on a specific filter hook, specifying arguments in an array.
*
* @param string $tag The name of the filter hook.
* @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
*
* @return mixed The filtered value after all hooked functions are applied to it.
*
* @access public
* @since 1.0.0
*/
public function apply_filters_ref_array($tag, $args)
{
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->__call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return $args[0];
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_) {
if (null !== $the_['function']) {
if (null !== $the_['include_path']) {
/** @noinspection PhpIncludeInspection */
include_once $the_['include_path'];
}
$args[0] = call_user_func_array($the_['function'], $args);
}
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return $args[0];
}
/**
* ACTIONS
*/
/**
* Hooks a function on to a specific action.
*
* @param string $tag The name of the action to which the
* <tt>$function_to_add</tt> is hooked.
* @param string $function_to_add The name of the function you wish to be called.
* @param integer $priority (optional) Used to specify the order in which
* the functions associated with a particular
* action are executed (default: 50).
* Lower numbers correspond with earlier execution,
* and functions with the same priority are executed
* in the order in which they were added to the action.
* @param string $include_path optional. File to include before executing the callback.
*
* @access public
* @since 1.0.0
* @return bool
*/
public function add_action($tag, $function_to_add, $priority = self::PRIORITY_NEUTRAL, $include_path = null)
{
return $this->add_filter($tag, $function_to_add, $priority, $include_path);
}
/**
* Check if any action has been registered for a hook.
*
* Info: Use !== false to check if it's true!
*
* @param string $tag The name of the action hook.
* @param bool|string $function_to_check (optional)
*
* @return mixed If <tt>$function_to_check</tt> is omitted,
* returns boolean for whether the hook has
* anything registered.
* When checking a specific function,
* the priority of that hook is returned,
* or false if the function is not attached.
* When using the <tt>$function_to_check</tt>
* argument, this function may return a non-boolean
* value that evaluates to false (e.g.) 0,
* so use the === operator for testing the return value.
* @access public
* @since 1.0.0
*/
public function has_action($tag, $function_to_check = false)
{
return $this->has_filter($tag, $function_to_check);
}
/**
* Removes a function from a specified action hook.
*
* @param string $tag the action hook to which the function to be removed is hooked.
* @param mixed $function_to_remove the name of the function which should be removed.
* @param int $priority [optional] The priority of the function (default: 50).
*
* @return bool Whether the function is removed.
*/
public function remove_action($tag, $function_to_remove, $priority = self::PRIORITY_NEUTRAL)
{
return $this->remove_filter($tag, $function_to_remove, $priority);
}
/**
* Remove all of the hooks from an action.
*
* @param string $tag the action to remove hooks from.
* @param bool $priority the priority number to remove them from.
*
* @return bool True when finished.
*/
public function remove_all_actions($tag, $priority = false)
{
return $this->remove_all_filters($tag, $priority);
}
/**
* Execute functions hooked on a specific action hook.
*
* @param string $tag The name of the action to be executed.
* @param mixed $arg ,.. Optional additional arguments which are passed on
* to the functions hooked to the action.
*
* @return bool Will return false if $tag does not exist in $filter array
* @access public
* @since 1.0.0
*/
public function do_action($tag, $arg = '')
{
if (!is_array($this->actions)) {
$this->actions = array();
}
if (!isset($this->actions[$tag])) {
$this->actions[$tag] = 1;
} else {
++$this->actions[$tag];
}
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->__call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return false;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
$args = array();
if (
is_array($arg)
&&
isset($arg[0])
&&
is_object($arg[0])
&&
1 == count($arg)
) {
$args[] =& $arg[0];
} else {
$args[] = $arg;
}
$numArgs = func_num_args();
for ($a = 2; $a < $numArgs; $a++) {
$args[] = func_get_arg($a);
}
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_) {
if (null !== $the_['function']) {
if (null !== $the_['include_path']) {
/** @noinspection PhpIncludeInspection */
include_once $the_['include_path'];
}
call_user_func_array($the_['function'], $args);
}
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return true;
}
/**
* Execute functions hooked on a specific action hook, specifying arguments in an array.
*
* @param string $tag The name of the action to be executed.
* @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
*
* @return bool Will return false if $tag does not exist in $filter array
* @access public
* @since 1.0.0
*/
public function do_action_ref_array($tag, $args)
{
if (!is_array($this->actions)) {
$this->actions = array();
}
if (!isset($this->actions[$tag])) {
$this->actions[$tag] = 1;
} else {
++$this->actions[$tag];
}
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->__call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return false;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($merged_filters[$tag])) {
ksort($this->filters[$tag]);
$merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_) {
if (null !== $the_['function']) {
if (null !== $the_['include_path']) {
/** @noinspection PhpIncludeInspection */
include_once $the_['include_path'];
}
call_user_func_array($the_['function'], $args);
}
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return true;
}
/**
* Retrieve the number of times an action has fired.
*
* @param string $tag The name of the action hook.
*
* @return integer The number of times action hook <tt>$tag</tt> is fired
* @access public
* @since 1.0.0
*/
public function did_action($tag)
{
if (!is_array($this->actions) || !isset($this->actions[$tag])) {
return 0;
}
return $this->actions[$tag];
}
/**
* HELPERS
*/
/**
* Retrieve the name of the current filter or action.
*
* @param void
*
* @return string Hook name of the current filter or action.
* @access public
* @since 1.0.0
*/
public function current_filter()
{
return end($this->current_filter);
}
/**
* Build Unique ID for storage and retrieval.
*
* @param string $function Used for creating unique id
*
* @return string|bool Unique ID for usage as array key or false if
* $priority === false and $function is an
* object reference, and it does not already have a unique id.
* @access private
* @since 1.0.0
*/
private function __filter_build_unique_id($function)
{
if (is_string($function)) {
return $function;
}
if (is_object($function)) {
// Closures are currently implemented as objects
$function = array(
$function,
'',
);
} else {
$function = (array)$function;
}
if (is_object($function[0])) {
// Object Class Calling
return spl_object_hash($function[0]) . $function[1];
} elseif (is_string($function[0])) {
// Static Calling
return $function[0] . $function[1];
}
return false;
}
/**
* Call "All" Hook
*
* @param array $args
*
* @access public
* @since 1.0.0
*/
public function __call_all_hook($args)
{
reset($this->filters['all']);
do {
foreach ((array)current($this->filters['all']) as $the_) {
if (null !== $the_['function']) {
if (null !== $the_['include_path']) {
/** @noinspection PhpIncludeInspection */
include_once $the_['include_path'];
}
call_user_func_array($the_['function'], $args);
}
}
} while (next($this->filters['all']) !== false);
}
/**
* Add hook for shortcode tag.
*
* There can only be one hook for each shortcode. Which means that if another
* plugin has a similar shortcode, it will override yours or yours will override
* theirs depending on which order the plugins are included and/or ran.
*
* Simplest example of a shortcode tag using the API:
*
* <code>
* // [footag foo="bar"]
* function footag_func($atts) {
* return "foo = {$atts[foo]}";
* }
* add_shortcode('footag', 'footag_func');
* </code>
*
* Example with nice attribute defaults:
*
* <code>
* // [bartag foo="bar"]
* function bartag_func($atts) {
* $args = shortcode_atts(array(
* 'foo' => 'no foo',
* 'baz' => 'default baz',
* ), $atts);
*
* return "foo = {$args['foo']}";
* }
* add_shortcode('bartag', 'bartag_func');
* </code>
*
* Example with enclosed content:
*
* <code>
* // [baztag]content[/baztag]
* function baztag_func($atts, $content='') {
* return "content = $content";
* }
* add_shortcode('baztag', 'baztag_func');
* </code>
*
* @since 1.0.0
*
* @param string $tag Shortcode tag to be searched in post content.
* @param callable $func Hook to run when shortcode is found.
*
* @return bool
*/
public function add_shortcode($tag, $func)
{
if (is_callable($func)) {
self::$shortcode_tags[$tag] = $func;
return true;
}
return false;
}
/**
* Removes hook for shortcode.
*
* @since 1.0.0
*
* @param string $tag shortcode tag to remove hook for.
*
* @return bool
*/
public function remove_shortcode($tag)
{
if (isset(self::$shortcode_tags[$tag])) {
unset(self::$shortcode_tags[$tag]);
return true;
} else {
return false;
}
}
/**
* This function is simple, it clears all of the shortcode tags by replacing the
* shortcodes by a empty array. This is actually a very efficient method
* for removing all shortcodes.
*
* @since 1.0.0
*
* @return bool
*/
public function remove_all_shortcodes()
{
self::$shortcode_tags = array();
return true;
}
/**
* Whether a registered shortcode exists named $tag
*
* @since 1.0.0
*
* @param string $tag
*
* @return boolean
*/
public function shortcode_exists($tag)
{
return array_key_exists($tag, self::$shortcode_tags);
}
/**
* Whether the passed content contains the specified shortcode
*
* @since 1.0.0
*
* @param $content
* @param $tag
*
* @return bool
*/
public function has_shortcode($content, $tag)
{
if (false === strpos($content, '[')) {
return false;
}
if ($this->shortcode_exists($tag)) {
preg_match_all('/' . $this->get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER);
if (empty($matches)) {
return false;
}
foreach ($matches as $shortcode) {
if ($tag === $shortcode[2]) {
return true;
} elseif (!empty($shortcode[5]) && $this->has_shortcode($shortcode[5], $tag)) {
return true;
}
}
}
return false;
}
/**
* Search content for shortcodes and filter shortcodes through their hooks.
*
* If there are no shortcode tags defined, then the content will be returned
* without any filtering. This might cause issues when plugins are disabled but
* the shortcode will still show up in the post or content.
*
* @since 1.0.0
*
* @param string $content Content to search for shortcodes
*
* @return string Content with shortcodes filtered out.
*/
public function do_shortcode($content)
{
if (empty(self::$shortcode_tags) || !is_array(self::$shortcode_tags)) {
return $content;
}
$pattern = $this->get_shortcode_regex();
return preg_replace_callback(
"/$pattern/s",
array(
$this,
'__do_shortcode_tag',
),
$content
);
}
/**
* Retrieve the shortcode regular expression for searching.
*
* The regular expression combines the shortcode tags in the regular expression
* in a regex class.
*
* The regular expression contains 6 different sub matches to help with parsing.
*
* 1 - An extra [ to allow for escaping shortcodes with double [[]]
* 2 - The shortcode name
* 3 - The shortcode argument list
* 4 - The self closing /
* 5 - The content of a shortcode when it wraps some content.
* 6 - An extra ] to allow for escaping shortcodes with double [[]]
*
* @since 1.0.0
*
* @return string The shortcode search regular expression
*/
public function get_shortcode_regex()
{
$tagnames = array_keys(self::$shortcode_tags);
$tagregexp = implode('|', array_map('preg_quote', $tagnames));
// WARNING! Do not change this regex without changing __do_shortcode_tag() and __strip_shortcode_tag()
// Also, see shortcode_unautop() and shortcode.js.
return
'\\[' // Opening bracket
. '(\\[?)' // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
. "($tagregexp)" // 2: Shortcode name
. '(?![\\w-])' // Not followed by word character or hyphen
. '(' // 3: Unroll the loop: Inside the opening shortcode tag
. '[^\\]\\/]*' // Not a closing bracket or forward slash
. '(?:'
. '\\/(?!\\])' // A forward slash not followed by a closing bracket
. '[^\\]\\/]*' // Not a closing bracket or forward slash
. ')*?'
. ')'
. '(?:'
. '(\\/)' // 4: Self closing tag ...
. '\\]' // ... and closing bracket
. '|'
. '\\]' // Closing bracket
. '(?:'
. '(' // 5: Unroll the loop: Optionally, anything between the opening and closing shortcode tags
. '[^\\[]*+' // Not an opening bracket
. '(?:'
. '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
. '[^\\[]*+' // Not an opening bracket
. ')*+'
. ')'
. '\\[\\/\\2\\]' // Closing shortcode tag
. ')?'
. ')'
. '(\\]?)'; // 6: Optional second closing brocket for escaping shortcodes: [[tag]]
}
/**
* Regular Expression callable for do_shortcode() for calling shortcode hook.
*
* @see get_shortcode_regex for details of the match array contents.
*
* @since 1.0.0
* @access private
*
* @param array $m Regular expression match array
*
* @return mixed False on failure.
*/
private function __do_shortcode_tag($m)
{
// allow [[foo]] syntax for escaping a tag
if ($m[1] == '[' && $m[6] == ']') {
return substr($m[0], 1, -1);
}
$tag = $m[2];
$attr = $this->shortcode_parse_atts($m[3]);
if (isset($m[5])) {
// enclosing tag - extra parameter
return $m[1] . call_user_func(self::$shortcode_tags[$tag], $attr, $m[5], $tag) . $m[6];
} else {
// self-closing tag
return $m[1] . call_user_func(self::$shortcode_tags[$tag], $attr, null, $tag) . $m[6];
}
}
/**
* Retrieve all attributes from the shortcodes tag.
*
* The attributes list has the attribute name as the key and the value of the