abstract-wcs-dynamic-hook-deprecator.php
2.39 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
<?php
/**
* Deprecate actions and filters that use a dynamic hook by appending a variable, like a payment gateway's name.
*
* @package WooCommerce Subscriptions
* @subpackage WCS_Hook_Deprecator
* @category Class
* @author Prospress
* @since 2.0
*/
abstract class WCS_Dynamic_Hook_Deprecator extends WCS_Hook_Deprecator {
/* The prefixes of hooks that have been deprecated, 'new_hook' => 'old_hook_prefix' */
protected $deprecated_hook_prefixes = array();
/**
* Bootstraps the class and hooks required actions & filters.
*
* We need to use the special 'all' hook here because we don't actually know the full hook names
* in advance, just their prefix. We can't simply hook in to 'plugins_loaded' and check the
* $wp_filter global for our hooks either, because sometime, hooks are dynamically hooked based
* on other hooks. Sigh.
*
* @since 2.0
*/
public function __construct() {
add_filter( 'all', array( &$this, 'check_for_deprecated_hooks' ) );
}
/**
* Check if the current hook contains the prefix of any dynamic hook that has been deprecated.
*
* @since 2.0
*/
public function check_for_deprecated_hooks() {
$current_filter = current_filter();
foreach ( $this->deprecated_hook_prefixes as $new_hook_prefix => $old_hook_prefixes ) {
if ( is_array( $old_hook_prefixes ) ) {
foreach ( $old_hook_prefixes as $old_hook_prefix ) {
$this->check_for_deprecated_hook( $current_filter, $new_hook_prefix, $old_hook_prefix );
}
} else {
$this->check_for_deprecated_hook( $current_filter, $new_hook_prefix, $old_hook_prefixes );
}
}
}
/**
* Check if a given hook contains the prefix and if it does, attach the @see $this->maybe_handle_deprecated_hook() method
* as a callback to it.
*
* @since 2.0
*/
protected function check_for_deprecated_hook( $current_hook, $new_hook_prefix, $old_hook_prefix ) {
if ( false !== strpos( $current_hook, $new_hook_prefix ) ) {
// Get the dynamic suffix on the hook, usually a payment gateway name, like 'stripe' or 'authorize_net_cim'
$hook_suffix = str_replace( $new_hook_prefix, '', $current_hook );
$old_hook = $old_hook_prefix . $hook_suffix;
// register the entire new and old hook
$this->deprecated_hooks[ $current_hook ][] = $old_hook;
// and attach our handler now that we know the hooks
add_filter( $current_hook, array( &$this, 'maybe_handle_deprecated_hook' ), -1000, 8 );
}
}
}