3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Utils_Hook_WordPress
extends CRM_Utils_Hook
{
38 private $isBuilt = FALSE;
43 private $allModules = NULL;
48 private $civiModules = NULL;
53 private $wordpressModules = NULL;
58 private $hooksThatReturn = array(
60 'civicrm_caseSummary',
67 * @param int $numParams
68 * Number of parameters to pass to the hook.
70 * Parameter to be passed to the hook.
72 * Parameter to be passed to the hook.
74 * Parameter to be passed to the hook.
76 * Parameter to be passed to the hook.
78 * Parameter to be passed to the hook.
80 * Parameter to be passed to the hook.
81 * @param string $fnSuffix
82 * Function suffix, this is effectively the hook name.
86 public function invokeViaUF(
88 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
92 // do_action_ref_array is the default way of calling WordPress hooks
93 // because for the most part no return value is wanted. However, this is
94 // only generally true, so using do_action_ref_array() is only called for those
95 // hooks which do not require a return value. We exclude the following, which
96 // are incompatible with the WordPress Plugin API:
99 // http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_upgrade
101 // civicrm_caseSummary
102 // http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_caseSummary
105 // http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_dashboard
107 // distinguish between types of hook
108 if (!in_array($fnSuffix, $this->hooksThatReturn
)) {
110 // only pass the arguments that have values
112 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6),
117 // Use WordPress Plugins API to modify $args
119 // Because $args are passed as references to the WordPress callbacks,
120 // runHooks subsequently receives appropriately modified parameters.
122 // protect from REST calls
123 if (function_exists('do_action_ref_array')) {
124 do_action_ref_array($fnSuffix, $args);
129 // The following is based on the logic of the Joomla hook file by allowing
130 // WordPress callbacks to do their stuff before runHooks gets called.
132 // It also follows the logic of the Drupal hook file by building the "module"
133 // (read "plugin") list and then calling runHooks directly. This should avoid
134 // the need for the post-processing that the Joomla hook file does.
136 // Note that hooks which require a return value are incompatible with the
137 // signature of apply_filters_ref_array and must therefore be called in
138 // global scope, like in Drupal. It's not ideal, but plugins can always route
139 // these calls to methods in their classes.
141 // At some point, those hooks could be pre-processed and called via the WordPress
142 // Plugin API, but it would change their signature and require the CiviCRM docs
143 // to be rewritten for those calls in WordPress. So it's been done this way for
144 // now. Ideally these hooks will be deprecated in favour of hooks that do not
145 // require return values.
147 // build list of registered plugin codes
148 $this->buildModuleList();
150 // Call runHooks the same way Drupal does
151 $moduleResult = $this->runHooks(
155 $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
159 return empty($moduleResult) ?
TRUE : $moduleResult;
165 * Build the list of plugins ("modules" in CiviCRM terminology) to be processed for hooks.
167 * We need to do this to preserve the CiviCRM hook signatures for hooks that require
168 * a return value, since the WordPress Plugin API seems to be incompatible with them.
170 * Copied and adapted from: CRM/Utils/Hook/Drupal6.php
172 public function buildModuleList() {
173 if ($this->isBuilt
=== FALSE) {
175 if ($this->wordpressModules
=== NULL) {
177 // include custom PHP file - copied from parent->commonBuildModuleList()
178 $config = CRM_Core_Config
::singleton();
179 if (!empty($config->customPHPPathDir
) &&
180 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
182 @include_once
"{$config->customPHPPathDir}/civicrmHooks.php";
185 // initialise with the pre-existing 'wordpress' prefix
186 $this->wordpressModules
= array('wordpress');
188 // Use WordPress Plugin API to build list
189 // a plugin simply needs to declare its "unique_plugin_code" thus:
190 // add_filter('civicrm_wp_plugin_codes', 'function_that_returns_my_unique_plugin_code');
192 // protect from REST calls
193 if (function_exists('apply_filters')) {
194 $this->wordpressModules
= apply_filters('civicrm_wp_plugin_codes', $this->wordpressModules
);
199 if ($this->civiModules
=== NULL) {
200 $this->civiModules
= array();
201 $this->requireCiviModules($this->civiModules
);
204 $this->allModules
= array_merge((array) $this->wordpressModules
, (array) $this->civiModules
);
205 if ($this->wordpressModules
!== NULL && $this->civiModules
!== NULL) {
206 // both CRM and CMS have bootstrapped, so this is the final list
207 $this->isBuilt
= TRUE;