/wp-content/plugins/google-analytics-for-wordpress/includes/deprecated.php

https://bitbucket.org/carloskikea/helpet · PHP · 236 lines · 40 code · 19 blank · 177 comment · 12 complexity · 08e6cda48a46266aa1e2e9bcb0fb1719 MD5 · raw file 

    

  1. <?php

    2. 

  2. /**

    3. 

  3.  * Deprecated functions.

    4. 

  4.  *

    5. 

  5.  * Contains the functions used to deprecate functions and

    6. 

  6.  * hooks in MonsterInsights, as well as the deprecated functions

    7. 

  7.  * and hooks themselves, where possible.

    8. 

  8.  * 

    9. 

  9.  * @since 6.0.0

    10. 

  10.  *

    11. 

  11.  * @package MonsterInsights

    12. 

  12.  * @subpackage Deprecated

    13. 

  13.  * @author  Chris Christoff

    14. 

  14.  */

    15. 

  15. 

    16. 

  16. // Exit if accessed directly

    17. 

  17. if ( ! defined( 'ABSPATH' ) ) {

    18. 

  18. 	exit;

    19. 

  19. }

    20. 

  20. 

    21. 

  21. /**

    22. 

  22.  * Fires functions attached to a deprecated filter hook.

    23. 

  23.  *

    24. 

  24.  * When a filter hook is deprecated, the apply_filters() call is replaced with

    25. 

  25.  * apply_filters_deprecated(), which triggers a deprecation notice and then fires

    26. 

  26.  * the original filter hook. Note, this is a copy of WordPress core's _apply_filters_deprecated

    27. 

  27.  * function, that we've copied into MonsterInsights so that we can use it on WordPress

    28. 

  28.  * versions older than 6.0.0 (when it was introduced to core). If we ever bump our

    29. 

  29.  * minimum WP version requirements above 6.0.0, we'll remove this function.

    30. 

  30.  *

    31. 

  31.  * @since 6.0.0

    32. 

  32.  * @access private

    33. 

  33.  *

    34. 

  34.  * @see _apply_filters_deprecated()

    35. 

  35.  *

    36. 

  36.  * @param string $tag         The name of the filter hook.

    37. 

  37.  * @param array  $args        Array of additional function arguments to be passed to apply_filters().

    38. 

  38.  * @param string $version     The version of WordPress that deprecated the hook.

    39. 

  39.  * @param string $message     Optional. A message regarding the change. Default null.

    40. 

  40.  */

    41. 

  41. function _monsterinsights_apply_filters_deprecated( $tag, $args, $version, $message = null ) {

    42. 

  42. 		if ( ! has_filter( $tag ) ) {

    43. 

  43. 				return $args[0];

    44. 

  44. 		}

    45. 

  45. 

    46. 

  46. 		_monsterinsights_deprecated_hook( $tag, $version, $message );

    47. 

  47. 

    48. 

  48. 		return apply_filters_ref_array( $tag, $args );

    49. 

  49. }

    50. 

  50. 

    51. 

  51. /**

    52. 

  52.  * Fires functions attached to a deprecated action hook.

    53. 

  53.  *

    54. 

  54.  * When an action hook is deprecated, the do_action() call is replaced with

    55. 

  55.  * do_action_deprecated(), which triggers a deprecation notice and then fires

    56. 

  56.  * the original hook. Note, this is a copy of WordPress core's _do_action_deprecated

    57. 

  57.  * function, that we've copied into MonsterInsights so that we can use it on WordPress

    58. 

  58.  * versions older than 6.0.0 (when it was introduced to core). If we ever bump our

    59. 

  59.  * minimum WP version requirements above 6.0.0, we'll remove this function.

    60. 

  60.  *

    61. 

  61.  * @since 6.0.0

    62. 

  62.  * @access private

    63. 

  63.  *

    64. 

  64.  * @see _do_action_deprecated()

    65. 

  65.  *

    66. 

  66.  * @param string $tag         The name of the action hook.

    67. 

  67.  * @param array  $args        Array of additional function arguments to be passed to do_action().

    68. 

  68.  * @param string $version     The version of WordPress that deprecated the hook.

    69. 

  69.  * @param string $message     Optional. A message regarding the change.

    70. 

  70.  */

    71. 

  71. function _monsterinsights_do_action_deprecated( $tag, $args, $version, $message = null ) {

    72. 

  72. 		if ( ! has_action( $tag ) ) {

    73. 

  73. 				return;

    74. 

  74. 		}

    75. 

  75. 

    76. 

  76. 		_monsterinsights_deprecated_hook( $tag, $version, $message );

    77. 

  77. 

    78. 

  78. 		do_action_ref_array( $tag, $args );

    79. 

  79. }

    80. 

  80. 

    81. 

  81. /**

    82. 

  82.  * Marks a deprecated action or filter hook as deprecated and throws a notice.

    83. 

  83.  *

    84. 

  84.  * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where

    85. 

  85.  * the deprecated hook was called.

    86. 

  86.  *

    87. 

  87.  * Default behavior is to trigger a user error if `WP_DEBUG` is true.

    88. 

  88.  *

    89. 

  89.  * This function is called by the do_action_deprecated() and apply_filters_deprecated()

    90. 

  90.  * functions, and so generally does not need to be called directly.

    91. 

  91.  *

    92. 

  92.  * Note, this is a copy of WordPress core's _deprecated_hook

    93. 

  93.  * function, that we've copied into MonsterInsights so that we can use it on WordPress

    94. 

  94.  * versions older than 6.0.0 (when it was introduced to core). If we ever bump our

    95. 

  95.  * minimum WP version requirements above 6.0.0, we'll remove this function.

    96. 

  96.  *

    97. 

  97.  * @since 6.0.0

    98. 

  98.  * @access private

    99. 

  99.  *

    100. 

  100.  * @param string $hook        The hook that was used.

    101. 

  101.  * @param string $version     The version of WordPress that deprecated the hook.

    102. 

  102.  * @param string $message     Optional. A message regarding the change.

    103. 

  103.  */

    104. 

  104. function _monsterinsights_deprecated_hook( $hook, $version, $message = null ) {

    105. 

  105. 	/**

    106. 

  106. 	 * Fires when a deprecated hook is called.

    107. 

  107. 	 *

    108. 

  108. 	 * @since 6.0.0

    109. 

  109. 	 *

    110. 

  110. 	 * @param string $hook        The hook that was called.

    111. 

  111. 	 * @param string $version     The version of MonsterInsights that deprecated the hook used.

    112. 

  112. 	 * @param string $message     A message regarding the change.

    113. 

  113. 	 */

    114. 

  114. 	do_action( 'deprecated_hook_run', $hook, $version, $message );

    115. 

  115.  

    116. 

  116. 	/**

    117. 

  117. 	 * Filters whether to trigger deprecated hook errors.

    118. 

  118. 	 *

    119. 

  119. 	 * @since 6.0.0

    120. 

  120. 	 *

    121. 

  121. 	 * @param bool $trigger Whether to trigger deprecated hook errors. Requires

    122. 

  122. 	 *                      `WP_DEBUG` to be defined true.

    123. 

  123. 	 */

    124. 

  124. 	if ( ( WP_DEBUG && apply_filters( 'deprecated_hook_trigger_error', true ) ) || monsterinsights_is_debug_mode() ) {

    125. 

  125. 		$message = empty( $message ) ? '' : ' ' . $message;

    126. 

  126. 		trigger_error( sprintf( esc_html__( '%1$s is %3$sdeprecated%4$s since MonsterInsights version %2$s!', 'google-analytics-for-wordpress' ), $hook, $version, '<strong>', '</strong>' ) . esc_html ( $message ) );

    127. 

  127. 	}

    128. 

  128. }

    129. 

  129. 

    130. 

  130. /**

    131. 

  131.  * Marks a function as deprecated and informs when it has been used.

    132. 

  132.  *

    133. 

  133.  * There is a hook monsterinsights_deprecated_function_run that will be called that can be used

    134. 

  134.  * to get the backtrace up to what file and function called the deprecated

    135. 

  135.  * function. Based on the one in EDD core.

    136. 

  136.  *

    137. 

  137.  * The current behavior is to trigger a user error if WP_DEBUG is true.

    138. 

  138.  *

    139. 

  139.  * This function is to be used in every function that is deprecated.

    140. 

  140.  *

    141. 

  141.  * @since 6.0.0

    142. 

  142.  * @access private

    143. 

  143.  *

    144. 

  144.  * @uses do_action() Calls 'monsterinsights_deprecated_function_run' and passes the function name, what to use instead,

    145. 

  145.  *   and the version the function was deprecated in.

    146. 

  146.  * @uses apply_filters() Calls 'monsterinsights_deprecated_function_trigger_error' and expects boolean value of true to do

    147. 

  147.  *   trigger or false to not trigger error.

    148. 

  148.  *   

    149. 

  149.  * @param string  $function    The function that was called

    150. 

  150.  * @param string  $version     The version of WordPress that deprecated the function

    151. 

  151.  * @param array   $backtrace   Optional. Contains stack backtrace of deprecated function

    152. 

  152.  * @return void

    153. 

  153.  */

    154. 

  154. function _monsterinsights_deprecated_function( $function, $version, $backtrace = null ) {

    155. 

  155. 

    156. 

  156. 	/**

    157. 

  157. 	 * Deprecated Function Action.

    158. 

  158. 	 *

    159. 

  159. 	 * Allow plugin run an action on the use of a 

    160. 

  160. 	 * deprecated function. This could be used to

    161. 

  161. 	 * feed into an error logging program or file.

    162. 

  162. 	 *

    163. 

  163. 	 * @since 6.0.0

    164. 

  164. 	 * 

    165. 

  165. 	 * @param string  $function    The function that was called.

    166. 

  166. 	 * @param string  $version     The version of WordPress that deprecated the function.

    167. 

  167. 	 * @param array   $backtrace   Optional. Contains stack backtrace of deprecated function.

    168. 

  168. 	 */	

    169. 

  169. 	do_action( 'deprecated_function_run', $function, $version, $backtrace );

    170. 

  170. 

    171. 

  171. 	/**

    172. 

  172. 	 * Filters whether to trigger an error for deprecated functions.

    173. 

  173. 	 *

    174. 

  174. 	 * @since 6.0.0

    175. 

  175. 	 *

    176. 

  176. 	 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.

    177. 

  177. 	 */

    178. 

  178. 	if ( ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) || monsterinsights_is_debug_mode() ) {

    179. 

  179. 		trigger_error( sprintf( esc_html__( '%1$s is %3$sdeprecated%4$s since MonsterInsights version %2$s.', 'google-analytics-for-wordpress' ), $function, $version, '<strong>', '</strong>' ) );

    180. 

  180. 		trigger_error( print_r( $backtrace, 1 ) );// Limited to previous 1028 characters, but since we only need to move back 1 in stack that should be fine.

    181. 

  181. 		// Alternatively we could dump this to a file.

    182. 

  182. 	}

    183. 

  183. }

    184. 

  184. 

    185. 

  185. /**

    186. 

  186.  * Marks something as deprecated.

    187. 

  187.  *

    188. 

  188.  * The current behavior is to trigger a user error if WP_DEBUG is true.

    189. 

  189.  *

    190. 

  190.  * @since 6.0.0

    191. 

  191.  * @access private

    192. 

  192.  *

    193. 

  193.  * @uses apply_filters() Calls 'monsterinsights_deprecated_trigger_error' and expects boolean value of true to do

    194. 

  194.  *   trigger or false to not trigger error.

    195. 

  195.  *

    196. 

  196.  * @param string  $message     Deprecation message shown.

    197. 

  197.  * @return void

    198. 

  198.  */

    199. 

  199. function _monsterinsights_deprecated( $message ) {

    200. 

  200. 

    201. 

  201. 	/**

    202. 

  202. 	 * Deprecated Message Filter.

    203. 

  203. 	 *

    204. 

  204. 	 * Allow plugin to filter the deprecated message.

    205. 

  205. 	 *

    206. 

  206. 	 * @since 6.0.0

    207. 

  207. 	 * 

    208. 

  208. 	 * @param string $message Error message.

    209. 

  209. 	 */	

    210. 

  210. 	do_action( 'monsterinsights_deprecated_run', $message );

    211. 

  211. 

    212. 

  212. 	$show_errors = current_user_can( 'manage_options' );

    213. 

  213. 

    214. 

  214. 	/**

    215. 

  215. 	 * Deprecated Error Trigger.

    216. 

  216. 	 *

    217. 

  217. 	 * Allow plugin to filter the output error trigger.

    218. 

  218. 	 *

    219. 

  219. 	 * @since 6.0.0

    220. 

  220. 	 * 

    221. 

  221. 	 * @param bool $show_errors Whether to show errors.

    222. 

  222. 	 */

    223. 

  223. 	$show_errors = apply_filters( 'monsterinsights_deprecated_trigger_error', $show_errors );

    224. 

  224. 	if ( ( WP_DEBUG && $show_errors ) || monsterinsights_is_debug_mode() ) {

    225. 

  225. 		trigger_error( esc_html( $message ) );

    226. 

  226. 	}

    227. 

  227. }

    228. 

  228. 

    229. 

  229. 

    230. 

  230. /**

    231. 

  231.  * Start Deprecated Actions & Filters. 

    232. 

  232.  *

    233. 

  233.  * These backwards compatibility fixes may be removed at any time.

    234. 

  234.  * Users/Developers are encouraged to update their code as soon as possible.

    235. 

  235.  */
    236.