3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Utils_Hook_WordPress
extends CRM_Utils_Hook
{
40 private $isBuilt = FALSE;
45 private $allModules = NULL;
50 private $civiModules = NULL;
55 private $wordpressModules = NULL;
60 private $hooksThatReturn = array(
62 'civicrm_caseSummary',
69 * @param int $numParams
70 * Number of parameters to pass 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.
82 * Parameter to be passed to the hook.
83 * @param string $fnSuffix
84 * Function suffix, this is effectively the hook name.
88 public function invoke(
90 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
95 * do_action_ref_array is the default way of calling WordPress hooks
96 * because for the most part no return value is wanted. However, this is
97 * only generally true, so using do_action_ref_array() is only called for those
98 * hooks which do not require a return value. We exclude the following, which
99 * are incompatible with the WordPress Plugin API:
102 * http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_upgrade
104 * civicrm_caseSummary
105 * http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_caseSummary
108 * http://wiki.civicrm.org/confluence/display/CRMDOC43/hook_civicrm_dashboard
111 // distinguish between types of hook
112 if (!in_array($fnSuffix, $this->hooksThatReturn
)) {
114 // only pass the arguments that have values
116 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6),
122 * Use WordPress Plugins API to modify $args
124 * Because $args are passed as references to the WordPress callbacks,
125 * runHooks subsequently receives appropriately modified parameters.
128 // protect from REST calls
129 if (function_exists('do_action_ref_array')) {
130 do_action_ref_array($fnSuffix, $args);
136 * The following is based on the logic of the Joomla hook file by allowing
137 * WordPress callbacks to do their stuff before runHooks gets called.
139 * It also follows the logic of the Drupal hook file by building the "module"
140 * (read "plugin") list and then calling runHooks directly. This should avoid
141 * the need for the post-processing that the Joomla hook file does.
143 * Note that hooks which require a return value are incompatible with the
144 * signature of apply_filters_ref_array and must therefore be called in
145 * global scope, like in Drupal. It's not ideal, but plugins can always route
146 * these calls to methods in their classes.
148 * At some point, those hooks could be pre-processed and called via the WordPress
149 * Plugin API, but it would change their signature and require the CiviCRM docs
150 * to be rewritten for those calls in WordPress. So it's been done this way for
151 * now. Ideally these hooks will be deprecated in favour of hooks that do not
152 * require return values.
155 // build list of registered plugin codes
156 $this->buildModuleList();
158 // Call runHooks the same way Drupal does
159 $moduleResult = $this->runHooks(
163 $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
167 return empty($moduleResult) ?
TRUE : $moduleResult;
173 * Build the list of plugins ("modules" in CiviCRM terminology) to be processed for hooks.
174 * We need to do this to preserve the CiviCRM hook signatures for hooks that require
175 * a return value, since the WordPress Plugin API seems to be incompatible with them.
177 * Copied and adapted from: CRM/Utils/Hook/Drupal6.php
179 public function buildModuleList() {
180 if ($this->isBuilt
=== FALSE) {
182 if ($this->wordpressModules
=== NULL) {
184 // include custom PHP file - copied from parent->commonBuildModuleList()
185 $config = CRM_Core_Config
::singleton();
186 if (!empty($config->customPHPPathDir
) &&
187 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
189 @include_once
'civicrmHooks.php';
192 // initialise with the pre-existing 'wordpress' prefix
193 $this->wordpressModules
= array('wordpress');
196 * Use WordPress Plugin API to build list
197 * a plugin simply needs to declare its "unique_plugin_code" thus:
198 * add_filter('civicrm_wp_plugin_codes', 'function_that_returns_my_unique_plugin_code');
201 // protect from REST calls
202 if (function_exists('apply_filters')) {
203 $this->wordpressModules
= apply_filters('civicrm_wp_plugin_codes', $this->wordpressModules
);
208 if ($this->civiModules
=== NULL) {
209 $this->civiModules
= array();
210 $this->requireCiviModules($this->civiModules
);
213 $this->allModules
= array_merge((array) $this->wordpressModules
, (array) $this->civiModules
);
214 if ($this->wordpressModules
!== NULL && $this->civiModules
!== NULL) {
215 // both CRM and CMS have bootstrapped, so this is the final list
216 $this->isBuilt
= TRUE;