Newer
Older
<?php
/*
Plugin Name: CiviCRM
Description: CiviCRM - Growing and Sustaining Relationships
Author URI: https://civicrm.org/
Plugin URI: https://wiki.civicrm.org/confluence/display/CRMDOC/Installing+CiviCRM+for+WordPress
GitHub Plugin URI: https://github.com/tadpolecc/civicrm.git
License: AGPL3
Text Domain: civicrm
Domain Path: /languages
*/
/*
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
*
*/
/*
--------------------------------------------------------------------------------
WordPress resources for developers
--------------------------------------------------------------------------------
Not that they're ever adhered to anywhere other than core, but people do their
best to comply...
WordPress core coding standards:
http://make.wordpress.org/core/handbook/coding-standards/php/
WordPress HTML standards:
http://make.wordpress.org/core/handbook/coding-standards/html/
WordPress JavaScript standards:
http://make.wordpress.org/core/handbook/coding-standards/javascript/
--------------------------------------------------------------------------------
*/
// this file must not accessed directly
if ( ! defined( 'ABSPATH' ) ) exit;
// set version here: when it changes, will force JS to reload
define( 'CIVICRM_PLUGIN_VERSION', '5' );
// store reference to this file
if (!defined('CIVICRM_PLUGIN_FILE')) {
define( 'CIVICRM_PLUGIN_FILE', __FILE__ );
}
// store URL to this plugin's directory
if (!defined( 'CIVICRM_PLUGIN_URL')) {
define( 'CIVICRM_PLUGIN_URL', plugin_dir_url(CIVICRM_PLUGIN_FILE) );
}
// store PATH to this plugin's directory
if (!defined( 'CIVICRM_PLUGIN_DIR')) {
define( 'CIVICRM_PLUGIN_DIR', plugin_dir_path(CIVICRM_PLUGIN_FILE) );
}
/**
* The constant CIVICRM_SETTINGS_PATH is also defined in civicrm.config.php and
* may already have been defined there - e.g. by cron or external scripts.
*/
if ( !defined( 'CIVICRM_SETTINGS_PATH' ) ) {
/**
* Test where the settings file exists.
*
* If the settings file is found in the 4.6 and prior location, use that as
* CIVICRM_SETTINGS_PATH, otherwise use the new location.
*/
$upload_dir = wp_upload_dir();
$wp_civi_settings = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm.settings.php' ;
$wp_civi_settings_deprectated = CIVICRM_PLUGIN_DIR . 'civicrm.settings.php';
if (file_exists($wp_civi_settings_deprectated)) {
define( 'CIVICRM_SETTINGS_PATH', $wp_civi_settings_deprectated );
}
else {
define( 'CIVICRM_SETTINGS_PATH', $wp_civi_settings );
}
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
}
// test if Civi is installed
if ( file_exists( CIVICRM_SETTINGS_PATH ) ) {
define( 'CIVICRM_INSTALLED', TRUE );
} else {
define( 'CIVICRM_INSTALLED', FALSE );
}
// prevent CiviCRM from rendering its own header
define( 'CIVICRM_UF_HEAD', TRUE );
/**
* Define CiviCRM_For_WordPress Class
*/
class CiviCRM_For_WordPress {
/**
* Declare our properties
*/
/**
* @var CiviCRM_For_WordPress
*/
private static $instance;
// plugin context (broad)
static $in_wordpress;
// plugin context (specific)
static $context;
/**
* @var CiviCRM_For_WordPress_Shortcodes
*/
public $shortcodes;
/**
* @var CiviCRM_For_WordPress_Shortcodes_Modal
*/
public $modal;
/**
* @var CiviCRM_For_WordPress_Basepage
*/
public $basepage;
/**
* @var CiviCRM_For_WordPress_Users
*/
public $users;
// ---------------------------------------------------------------------------
// Setup
// ---------------------------------------------------------------------------
/**
* Getter method which returns the CiviCRM instance and optionally creates one
* if it does not already exist. Standard CiviCRM singleton pattern.
*
* @return object CiviCRM plugin instance
*/
public static function singleton() {
// if it doesn't already exist...
if ( ! isset( self::$instance ) ) {
// create it
self::$instance = new CiviCRM_For_WordPress;
self::$instance->setup_instance();
}
// return existing instance
return self::$instance;
}
/**
* Dummy instance constructor
*/
function __construct() {}
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
/**
* Dummy magic method to prevent CiviCRM_For_WordPress from being cloned
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, __( 'Only one instance of CiviCRM_For_WordPress please', 'civicrm' ), '4.4' );
}
/**
* Dummy magic method to prevent CiviCRM_For_WordPress from being unserialized
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, __( 'Please do not serialize CiviCRM_For_WordPress', 'civicrm' ), '4.4' );
}
/**
* Method that is called only when CiviCRM plugin is activated
* In order for other plugins to be able to interact with Civi's activation,
* we wait until after the activation redirect to perform activation actions
*
* @return void
*/
public function activate() {
// set a one-time-only option
add_option( 'civicrm_activation_in_progress', 'true' );
}
/**
* Method that runs CiviCRM's plugin activation methods
*
* @return void
*/
public function activation() {
// if activating...
if ( is_admin() && get_option( 'civicrm_activation_in_progress' ) == 'true' ) {
// assign minimum capabilities for all WP roles and create 'anonymous_user' role
$this->users->set_wp_user_capabilities();
// set a one-time-only option to flag that we need to create a basepage -
// it will not update the option once it has been set to another value nor
// create a new option with the same name
add_option( 'civicrm_activation_create_basepage', 'true' );
// change option so this method never runs again
update_option( 'civicrm_activation_in_progress', 'false' );
}
// if activating and we still haven't created the basepage...
if (
is_admin() &&
get_option( 'civicrm_activation_create_basepage' ) == 'true' &&
CIVICRM_INSTALLED
) {
// create basepage
add_action( 'wp_loaded', array( $this, 'create_wp_basepage' ) );
// change option so this method never runs again
update_option( 'civicrm_activation_create_basepage', 'done' );
}
}
/**
* Method that is called only when CiviCRM plugin is deactivated
* In order for other plugins to be able to interact with Civi's activation,
* we need to remove the option that is set in activate() above
*
* @return void
*/
public function deactivate() {
// delete options
delete_option( 'civicrm_activation_in_progress' );
delete_option( 'civicrm_activation_create_basepage' );
}
/**
* Set up the CiviCRM plugin instance
*
* @return void
*/
public function setup_instance() {
// kick out if another instance is being inited
if ( isset( self::$in_wordpress ) ) {
wp_die( __( 'Only one instance of CiviCRM_For_WordPress please', 'civicrm' ) );
}
// Store context
$this->civicrm_in_wordpress_set();
// there is no session handling in WP hence we start it for CiviCRM pages
if (!session_id()) {
session_start();
}
if ( $this->civicrm_in_wordpress() ) {
// this is required for AJAX calls in WordPress admin
$_GET['noheader'] = TRUE;
}
if ( !CIVICRM_INSTALLED && !$this->civicrm_in_wordpress() ) {
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
$_GET['civicrm_install_type'] = 'wordpress';
}
// get classes and instantiate
$this->include_files();
// do plugin activation
$this->activation();
// register all hooks
$this->register_hooks();
// notify plugins
do_action( 'civicrm_instance_loaded' );
}
/**
* Setter for determining if CiviCRM is currently being displayed in WordPress.
* This becomes true whe CiviCRM is called in the following contexts:
*
* (a) in the WordPress back-end
* (b) when CiviCRM content is being displayed on the front-end via wpBasePage
* (c) when an AJAX request is made to CiviCRM
*
* It is NOT true when CiviCRM is called via a shortcode
*
* @return void
*/
public function civicrm_in_wordpress_set() {
// store
self::$in_wordpress = ( isset( $_GET['page'] ) && $_GET['page'] == 'CiviCRM' ) ? TRUE : FALSE;
}
/**
* Getter for testing if CiviCRM is currently being displayed in WordPress.
*
* @see $this->civicrm_in_wordpress_set()
*
* @return bool $in_wordpress True if Civi is displayed in WordPress, false otherwise
*/
public function civicrm_in_wordpress() {
// already stored
return apply_filters( 'civicrm_in_wordpress', self::$in_wordpress );
}
/**
* Setter for determining how CiviCRM is currently being displayed in WordPress.
* This can be one of the following contexts:
*
* (a) in the WordPress back-end
* (b) when CiviCRM content is being displayed on the front-end via wpBasePage
* (c) when a "non-page" request is made to CiviCRM
* (d) when CiviCRM is called via a shortcode
*
* The following codes correspond to the different contexts
*
* (a) 'admin'
* (b) 'basepage'
* (c) 'nonpage'
* (d) 'shortcode'
*
* @param string $context
* One of the four context codes above
* @return void
*/
public function civicrm_context_set( $context ) {
// store
self::$context = $context;
}
/**
* Getter for determining how CiviCRM is currently being displayed in WordPress.
*
* @see $this->civicrm_context_set()
*
* @return string
* The context in which Civi is displayed in WordPress
*/
public function civicrm_context_get() {
// already stored
return apply_filters( 'civicrm_context', self::$context );
}
// ---------------------------------------------------------------------------
// Files
// ---------------------------------------------------------------------------
/**
* Include files
*
* @return void
*/
public function include_files() {
// include users class
include_once CIVICRM_PLUGIN_DIR . 'includes/civicrm.users.php';
$this->users = new CiviCRM_For_WordPress_Users;
// include shortcodes class
include_once CIVICRM_PLUGIN_DIR . 'includes/civicrm.shortcodes.php';
$this->shortcodes = new CiviCRM_For_WordPress_Shortcodes;
// include shortcodes modal dialog class
include_once CIVICRM_PLUGIN_DIR . 'includes/civicrm.shortcodes.modal.php';
$this->modal = new CiviCRM_For_WordPress_Shortcodes_Modal;
// include basepage class
include_once CIVICRM_PLUGIN_DIR . 'includes/civicrm.basepage.php';
$this->basepage = new CiviCRM_For_WordPress_Basepage;
}
// ---------------------------------------------------------------------------
// Hooks
// ---------------------------------------------------------------------------
/**
* Register hooks
*
* @return void
*/
public function register_hooks() {
// always add the common hooks
$this->register_hooks_common();
// when in WordPress admin...
if ( is_admin() ) {
// set context
$this->civicrm_context_set( 'admin' );
// handle WP admin context
$this->register_hooks_admin();
return;
}
// go no further if Civi not installed yet
if ( ! CIVICRM_INSTALLED ) return;
// when embedded via wpBasePage or AJAX call...
if ( $this->civicrm_in_wordpress() ) {
/**
* Directly output CiviCRM html only in a few cases and skip WP templating:
*
* (a) when a snippet is set
* (b) when there is an AJAX call
* (c) for an iCal feed (unless 'html' is specified)
* (d) for file download URLs
*/
if ( ! $this->is_page_request() ) {
// set context
$this->civicrm_context_set( 'nonpage' );
// add core resources for front end
add_action( 'wp', array( $this, 'front_end_page_load' ) );
// echo all output when WP has been set up but nothing has been rendered
add_action( 'wp', array( $this, 'invoke' ) );
return;
}
// set context
$this->civicrm_context_set( 'basepage' );
// if we get here, we must be in a wpBasePage context
$this->basepage->register_hooks();
return;
}
// set context
$this->civicrm_context_set( 'shortcode' );
// that leaves us with handling shortcodes, should they exist
$this->shortcodes->register_hooks();
}
/**
* Register hooks that must always be present
*
* @return void
*/
public function register_hooks_common() {
// use translation files
add_action( 'plugins_loaded', array( $this, 'enable_translation' ) );
// register user hooks
$this->users->register_hooks();
}
/**
* Register hooks to handle CiviCRM in a WordPress admin context
*
* @return void
*/
public function register_hooks_admin() {
// modify the admin menu
add_action( 'admin_menu', array( $this, 'add_menu_items' ) );
// set page title
add_filter( 'admin_title', array( $this, 'set_admin_title' ) );
// print CiviCRM's header
add_action('admin_head', array( $this, 'wp_head' ), 50);
// if settings file does not exist, show notice with link to installer
if ( ! CIVICRM_INSTALLED ) {
if ( isset( $_GET['page'] ) && $_GET['page'] == 'civicrm-install' ) {
// register hooks for installer page?
} else {
// show notice
add_action( 'admin_notices', array( $this, 'show_setup_warning' ) );
}
}
// enable shortcode modal
$this->modal->register_hooks();
}
// ---------------------------------------------------------------------------
// CiviCRM Initialisation
// ---------------------------------------------------------------------------
/**
* Initialize CiviCRM
*
* @return bool $success
*/
public function initialize() {
static $initialized = FALSE;
static $failure = FALSE;
if ( $failure ) {
return FALSE;
}
if ( ! $initialized ) {
// Check for php version and ensure its greater than minPhpVersion
$minPhpVersion = '5.3.4';
if ( version_compare( PHP_VERSION, $minPhpVersion ) < 0 ) {
echo '<p>' .
sprintf(
__( 'CiviCRM requires PHP Version %s or greater. You are running PHP Version %s', 'civicrm' ),
$minPhpVersion,
PHP_VERSION
) .
'<p>';
exit();
}
// check for settings
if ( ! CIVICRM_INSTALLED ) {
$error = FALSE;
} elseif ( file_exists( CIVICRM_SETTINGS_PATH) ) {
$error = include_once ( CIVICRM_SETTINGS_PATH );
}
// autoload
require_once 'CRM/Core/ClassLoader.php';
CRM_Core_ClassLoader::singleton()->register();
// get ready for problems
$installLink = admin_url() . "options-general.php?page=civicrm-install";
$docLinkInstall = "https://wiki.civicrm.org/confluence/display/CRMDOC/Installing+CiviCRM+for+WordPress";
$docLinkTrouble = "https://wiki.civicrm.org/confluence/display/CRMDOC/Installation+and+Upgrades";
$forumLink = "https://civicrm.stackexchange.com/";
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
// construct message
$errorMsgAdd = sprintf(
__( 'Please review the <a href="%s">WordPress Installation Guide</a> and the <a href="%s">Trouble-shooting page</a> for assistance. If you still need help installing, you can often find solutions to your issue by searching for the error message in the <a href="%s">installation support section of the community forum</a>.', 'civicrm' ),
$docLinkInstall,
$docLinkTrouble,
$forumLink
);
// does install message get used?
$installMessage = sprintf(
__( 'Click <a href="%s">here</a> for fresh install.', 'civicrm' ),
$installLink
);
if ($error == FALSE) {
header( 'Location: ' . admin_url() . 'options-general.php?page=civicrm-install' );
return FALSE;
}
// access global defined in civicrm.settings.php
global $civicrm_root;
// this does pretty much all of the civicrm initialization
if ( ! file_exists( $civicrm_root . 'CRM/Core/Config.php' ) ) {
$error = FALSE;
} else {
$error = include_once ( 'CRM/Core/Config.php' );
}
// have we got it?
if ( $error == FALSE ) {
// set static flag
$failure = TRUE;
// FIX ME - why?
wp_die(
"<strong><p class='error'>" .
sprintf(
__( 'Oops! - The path for including CiviCRM code files is not set properly. Most likely there is an error in the <em>civicrm_root</em> setting in your CiviCRM settings file (%s).', 'civicrm' ),
CIVICRM_SETTINGS_PATH
) .
"</p><p class='error'> » " .
sprintf(
__( 'civicrm_root is currently set to: <em>%s</em>.', 'civicrm' ),
$civicrm_root
) .
"</p><p class='error'>" . $errorMsgAdd . "</p></strong>"
);
// won't reach here!
return FALSE;
}
// set static flag
$initialized = TRUE;
// initialize the system by creating a config object
$config = CRM_Core_Config::singleton();
//print_r( $config ); die();
// sync the logged in user with WP
global $current_user;
if ( $current_user ) {
// sync procedure sets session values for logged in users
require_once 'CRM/Core/BAO/UFMatch.php';
CRM_Core_BAO_UFMatch::synchronize(
$current_user, // user object
FALSE, // do not update
'WordPress', // CMS
$this->users->get_civicrm_contact_type('Individual')
);
}
}
// notify plugins
do_action( 'civicrm_initialized' );
// success!
return TRUE;
}
// ---------------------------------------------------------------------------
// Plugin setup
// ---------------------------------------------------------------------------
/**
* Load translation files
* A good reference on how to implement translation in WordPress:
* http://ottopress.com/2012/internationalization-youre-probably-doing-it-wrong/
*
* @return void
*/
public function enable_translation() {
// not used, as there are no translations as yet
load_plugin_textdomain(
// unique name
'civicrm',
// deprecated argument
FALSE,
// relative path to directory containing translation files
dirname( plugin_basename( __FILE__ ) ) . '/languages/'
);
}
/**
* Adds menu items to WordPress admin menu
* Callback method for 'admin_menu' hook as set in register_hooks()
*
* @return void
*/
public function add_menu_items() {
$civilogo = file_get_contents( plugin_dir_path( __FILE__ ) . 'assets/civilogo.svg.b64' );
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
// check for settings file
if ( CIVICRM_INSTALLED ) {
// add top level menu item
$menu_page = add_menu_page(
__( 'CiviCRM', 'civicrm' ),
__( 'CiviCRM', 'civicrm' ),
'access_civicrm',
'CiviCRM',
array( $this, 'invoke' ),
$civilogo,
apply_filters( 'civicrm_menu_item_position', '3.904981' ) // 3.9 + random digits to reduce risk of conflict
);
// add core resources prior to page load
add_action( 'load-' . $menu_page, array( $this, 'admin_page_load' ) );
} else {
// add top level menu item
$menu_page = add_menu_page(
__( 'CiviCRM Installer', 'civicrm' ),
__( 'CiviCRM Installer', 'civicrm' ),
'manage_options',
'civicrm-install',
array( $this, 'run_installer' ),
$civilogo,
apply_filters( 'civicrm_menu_item_position', '3.904981' ) // 3.9 + random digits to reduce risk of conflict
);
/*
// add scripts and styles like this
add_action( 'admin_print_scripts-' . $options_page, array( $this, 'admin_installer_js' ) );
add_action( 'admin_print_styles-' . $options_page, array( $this, 'admin_installer_css' ) );
add_action( 'admin_head-' . $options_page, array( $this, 'admin_installer_head' ), 50 );
*/
}
}
// ---------------------------------------------------------------------------
// Installation
// ---------------------------------------------------------------------------
/**
* Callback method for add_options_page() that runs the CiviCRM installer
*
* @return void
*/
public function run_installer() {
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
$civicrmCore = CIVICRM_PLUGIN_DIR . 'civicrm';
$setupPaths = array(
implode(DIRECTORY_SEPARATOR, ['vendor', 'civicrm', 'civicrm-setup']),
implode(DIRECTORY_SEPARATOR, ['packages', 'civicrm-setup',]),
implode(DIRECTORY_SEPARATOR, ['setup']),
);
foreach ($setupPaths as $setupPath) {
$loader = implode(DIRECTORY_SEPARATOR, [$civicrmCore, $setupPath, 'civicrm-setup-autoload.php']);
if (file_exists($civicrmCore . DIRECTORY_SEPARATOR . '.use-civicrm-setup') && file_exists($loader)) {
require_once $loader;
require_once implode(DIRECTORY_SEPARATOR, [$civicrmCore, 'CRM', 'Core', 'ClassLoader.php']);
CRM_Core_ClassLoader::singleton()->register();
\Civi\Setup::assertProtocolCompatibility(1.0);
\Civi\Setup::init([
'cms' => 'WordPress',
'srcPath' => $civicrmCore,
]);
$ctrl = \Civi\Setup::instance()->createController()->getCtrl();
$ctrl->setUrls(array(
'ctrl' => admin_url() . "options-general.php?page=civicrm-install",
'res' => CIVICRM_PLUGIN_URL . 'civicrm/' . strtr($setupPath, DIRECTORY_SEPARATOR, '/') . '/res/',
'jquery.js' => CIVICRM_PLUGIN_URL . 'civicrm/bower_components/jquery/dist/jquery.min.js',
'font-awesome.css' => CIVICRM_PLUGIN_URL . 'civicrm/bower_components/font-awesome/css/font-awesome.min.css',
'finished' => admin_url('admin.php?page=CiviCRM&q=civicrm&reset=1'),
));
\Civi\Setup\BasicRunner::run($ctrl);
return;
}
}
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
// uses CIVICRM_PLUGIN_DIR instead of WP_PLUGIN_DIR
$installFile =
CIVICRM_PLUGIN_DIR .
'civicrm' . DIRECTORY_SEPARATOR .
'install' . DIRECTORY_SEPARATOR .
'index.php';
// Notice: Undefined variable: siteDir in:
// CIVICRM_PLUGIN_DIR/civicrm/install/index.php on line 456
include ( $installFile );
}
/**
* Callback method for missing settings file in register_hooks()
*
* @return void
*/
public function show_setup_warning() {
$installLink = admin_url() . "options-general.php?page=civicrm-install";
echo '<div id="civicrm-warning" class="updated fade">' .
'<p><strong>' .
__( 'CiviCRM is almost ready.', 'civicrm' ) .
'</strong> ' .
sprintf(
__( 'You must <a href="%s">configure CiviCRM</a> for it to work.', 'civicrm' ),
$installLink
) .
'</p></div>';
}
/**
* Create WordPress basepage and save setting
*
* @return void
*/
public function create_wp_basepage() {
if (!$this->initialize()) {
return;
}
$config = CRM_Core_Config::singleton();
// bail if we already have a basepage setting
if ( !empty( $config->wpBasePage ) ) {
return;
}
// default page slug, but allow overrides
$slug = apply_filters( 'civicrm_basepage_slug', 'civicrm' );
// get existing page with that slug
$page = get_page_by_path( $slug );
// does it exist?
if ( $page ) {
// we already have a basepage
$result = $page->ID;
} else {
// create the basepage
$result = $this->create_basepage( $slug );
}
// were we successful?
if ( $result !== 0 AND !is_wp_error($result) ) {
// get the post object
$post = get_post( $result );
$params = array(
'version' => 3,
'wpBasePage' => $post->post_name,
);
// save the setting
civicrm_api3('setting', 'create', $params);
}
}
/**
* Create a WordPress page to act as the CiviCRM base page.
*
* @param string $slug The unique slug for the page - same as wpBasePage setting
* @return int|WP_Error The page ID on success. The value 0 or WP_Error on failure
*/
private function create_basepage( $slug ) {
// if multisite, switch to main site
if ( is_multisite() && !is_main_site() ) {
// store this site
$original_site = get_current_blog_id();
// switch
global $current_site;
switch_to_blog( $current_site->blog_id );
}
// define basepage
$page = array(
'post_status' => 'publish',
'post_type' => 'page',
'post_parent' => 0,
'comment_status' => 'closed',
'ping_status' => 'closed',
'to_ping' => '', // quick fix for Windows
'pinged' => '', // quick fix for Windows
'post_content_filtered' => '', // quick fix for Windows
'post_excerpt' => '', // quick fix for Windows
'menu_order' => 0,
'post_name' => $slug,
);
// default page title, but allow overrides
$page['post_title'] = apply_filters( 'civicrm_basepage_title', __( 'CiviCRM', 'civicrm' ) );
// default content
$content = __( 'Do not delete this page. Page content is generated by CiviCRM.', 'civicrm' );
// set, but allow overrides
$page['post_content'] = apply_filters( 'civicrm_basepage_content', $content );
// insert the post into the database
$page_id = wp_insert_post( $page );
// switch back if we've switched
if ( isset( $original_site ) ) {
restore_current_blog();
}
return $page_id;
}
// ---------------------------------------------------------------------------
// HTML head
// ---------------------------------------------------------------------------
/**
* Perform necessary stuff prior to CiviCRM's admin page being loaded
* This needs to be a method because it can then be hooked into WP at the
* right time
*
* @return void
*/
public function admin_page_load() {
// add resources for back end
$this->add_core_resources( FALSE );
// check setting for path to wp-load.php
$this->add_wpload_setting();
}
/**
* When CiviCRM is loaded in WP Admin, check for the existence of a setting
* which holds the path to wp-load.php. This is the only reliable way to
* bootstrap WordPress from CiviCRM.
*
* CMW: I'm not entirely happy with this approach, because the value will be
* different for different installs (e.g. when a dev site is migrated to live)
* A better approach would be to store this setting in civicrm.settings.php as
* a constant, but doing that involves a complicated process of getting a new
* setting registered in the installer.
*
* Also, it needs to be decided whether this value should be tied to a CiviCRM
* 'domain', since a single CiviCRM install could potentially be used by a
* number of WordPress installs. This is not relevant to its use in WordPress
* Multisite, because the path to wp-load.php is common to all sites on the
* network.
*
* My final concern is that the value will only be set *after* someone visits
* CiviCRM in the back end. I have restricted it to this so as not to add
* overhead to the front end, but there remains the possibility that the value
* could be missing. To repeat: this would be better in civicrm.settings.php.
*
* To get the path to wp-load.php, use:
* $path = CRM_Core_BAO_Setting::getItem('CiviCRM Preferences', 'wpLoadPhp');
*
* @return void
*/
public function add_wpload_setting() {
if (!$this->initialize()) {
return;
}
// get path to wp-load.php
$path = ABSPATH . 'wp-load.php';
// get the setting, if it exists
$setting = CRM_Core_BAO_Setting::getItem('CiviCRM Preferences', 'wpLoadPhp');
// if we don't have one, create it
if ( is_null( $setting ) ) {
CRM_Core_BAO_Setting::setItem($path, 'CiviCRM Preferences', 'wpLoadPhp');
}
// is it different to the one we've stored?
if ( $setting !== $path ) {
// yes - set new path (this could be because we've changed server or location)
CRM_Core_BAO_Setting::setItem($path, 'CiviCRM Preferences', 'wpLoadPhp');
}
}
/**
* Perform necessary stuff prior to CiviCRM being loaded on the front end
* This needs to be a method because it can then be hooked into WP at the
* right time
*
* @return void
*/
public function front_end_page_load() {
static $frontend_loaded = FALSE;
if ( $frontend_loaded ) {
return;
}
// add resources for front end
$this->add_core_resources( TRUE );
// merge CiviCRM's HTML header with the WordPress theme's header
add_action( 'wp_head', array( $this, 'wp_head' ) );
// set flag so this only happens once
$frontend_loaded = TRUE;
}
/**
* Load only the CiviCRM CSS. This is needed because $this->front_end_page_load()
* is only called when there is a single Civi entity present on a page or archive
* and, whilst we don't want all the Javascript to load, we do want stylesheets
*
* @return void
*/
public function front_end_css_load() {
static $frontend_css_loaded = FALSE;
if ( $frontend_css_loaded ) {
return;
}
if (!$this->initialize()) {
return;
}
$config = CRM_Core_Config::singleton();
// default custom CSS to standalone
$dependent = NULL;
// Load core CSS
if (!CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'disable_core_css')) {
// enqueue stylesheet
wp_enqueue_style(
'civicrm_css',
$config->resourceBase . 'css/civicrm.css',
NULL, // dependencies
CIVICRM_PLUGIN_VERSION, // version
'all' // media
);
// custom CSS is dependent
$dependent = array( 'civicrm_css' );
}
// Load custom CSS
if (!empty($config->customCSSURL)) {
wp_enqueue_style(
'civicrm_custom_css',
$config->customCSSURL,
$dependent, // dependencies
CIVICRM_PLUGIN_VERSION, // version
'all' // media
);
}
// set flag so this only happens once
$frontend_css_loaded = TRUE;
}
/**
* Add CiviCRM core resources
*
* @param bool $front_end True if on WP front end, false otherwise
* @return void
*/
public function add_core_resources( $front_end = TRUE ) {
if (!$this->initialize()) {
return;
}
$config = CRM_Core_Config::singleton();
$config->userFrameworkFrontend = $front_end;
// add CiviCRM core resources
CRM_Core_Resources::singleton()->addCoreResources();
}
/**
* Merge CiviCRM's HTML header with the WordPress theme's header
* Callback from WordPress 'admin_head' and 'wp_head' hooks
*
* @return void
*/
public function wp_head() {
// CRM-11823 - If Civi bootstrapped, then merge its HTML header with the CMS's header
global $civicrm_root;
if ( empty( $civicrm_root ) ) {
return;
}
$region = CRM_Core_Region::instance('html-header', FALSE);
if ( $region ) {
echo '<!-- CiviCRM html header -->';
echo $region->render( '' );
}
}
// ---------------------------------------------------------------------------
// CiviCRM Invocation (this outputs Civi's markup)
// ---------------------------------------------------------------------------
/**
* Invoke CiviCRM in a WordPress context
* Callback function from add_menu_page()
* Callback from WordPress 'init' and 'the_content' hooks
* Also called by shortcode_render() and _civicrm_update_user()
*
* @return void
*/
public function invoke() {
static $alreadyInvoked = FALSE;
if ( $alreadyInvoked ) {
return;
}
// bail if this is called via a content-preprocessing plugin
if ( $this->is_page_request() && !in_the_loop() && !is_admin() ) {
return;
}
if (!$this->initialize()) {
return;
}
// CRM-12523
// WordPress has it's own timezone calculations
// Civi relies on the php default timezone which WP
// overrides with UTC in wp-settings.php
$wpBaseTimezone = date_default_timezone_get();
$wpUserTimezone = get_option('timezone_string');
if ($wpUserTimezone) {
date_default_timezone_set($wpUserTimezone);
CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
}
// CRM-95XX
// At this point we are calling a CiviCRM function
// WP always quotes the request, CiviCRM needs to reverse what it just did
$this->remove_wp_magic_quotes();
// Code inside invoke() requires the current user to be set up
$current_user = wp_get_current_user();
/**
* Bypass synchronize if running upgrade to avoid any serious non-recoverable
* error which might hinder the upgrade process.
*/
if ( CRM_Utils_Array::value('q', $_GET) != 'civicrm/upgrade' ) {
$this->users->sync_user( $current_user );
}
// set flag
$alreadyInvoked = TRUE;
// get args
$argdata = $this->get_request_args();
// set dashboard as default if args are empty
if ( !isset( $_GET['q'] ) ) {
$_GET['q'] = 'civicrm/dashboard';
$_GET['reset'] = 1;
$argdata['args'] = array('civicrm', 'dashboard');
}
// do the business
CRM_Core_Invoke::invoke($argdata['args']);
// restore WP's timezone
if ($wpBaseTimezone) {
date_default_timezone_set($wpBaseTimezone);
}
// restore WP's arrays
$this->restore_wp_magic_quotes();
// notify plugins
do_action( 'civicrm_invoked' );
}
/**
* Non-destructively override WordPress magic quotes
* Only called by invoke() to undo WordPress default behaviour
* CMW: Should probably be a private method
*
* @return void
*/
public function remove_wp_magic_quotes() {
// save original arrays
$this->wp_get = $_GET;
$this->wp_post = $_POST;
$this->wp_cookie = $_COOKIE;
$this->wp_request = $_REQUEST;
// reassign globals
$_GET = stripslashes_deep($_GET);
$_POST = stripslashes_deep($_POST);
$_COOKIE = stripslashes_deep($_COOKIE);
$_REQUEST = stripslashes_deep($_REQUEST);
}
/**
* Restore WordPress magic quotes
* Only called by invoke() to redo WordPress default behaviour
* CMW: Should probably be a private method
*
* @return void
*/
public function restore_wp_magic_quotes() {
// restore original arrays
$_GET = $this->wp_get;
$_POST = $this->wp_post;
$_COOKIE = $this->wp_cookie;
$_REQUEST = $this->wp_request;
}
/**
* Detect Ajax, snippet, or file requests
*
* @return boolean True if request is for a CiviCRM page, false otherwise
*/
public function is_page_request() {
// kick out if not CiviCRM
if (!$this->initialize()) {
return;
}
// get args
$argdata = $this->get_request_args();
// FIXME: It's not sustainable to hardcode a whitelist of all of non-HTML
// pages. Maybe the menu-XML should include some metadata to make this
// unnecessary?
if (CRM_Utils_Array::value('HTTP_X_REQUESTED_WITH', $_SERVER) == 'XMLHttpRequest'
|| ($argdata['args'][0] == 'civicrm' && in_array($argdata['args'][1], array('ajax', 'file')) )
|| !empty($_REQUEST['snippet'])
|| strpos($argdata['argString'], 'civicrm/event/ical') === 0 && empty($_GET['html'])
|| strpos($argdata['argString'], 'civicrm/contact/imagefile') === 0
) {
return FALSE;
}
else {
return TRUE;
}
}
/**
* Get arguments and request string from $_GET
*
* @return array $argdata Array containing request arguments and request string
*/
public function get_request_args() {
$argString = NULL;
$args = array();
if (isset( $_GET['q'])) {
$argString = trim($_GET['q']);
$args = explode('/', $argString);
}
$args = array_pad($args, 2, '');
return array(
'args' => $args,
'argString' => $argString
);
}
/**
* Add CiviCRM's title to the header's <title>
*
* @param string $title
* @return string
*/
public function set_admin_title($title) {
global $civicrm_wp_title;
if (!$civicrm_wp_title) {
return $title;
}
// Replace 1st occurance of "CiviCRM" in the title
$pos = strpos($title, 'CiviCRM');
if ($pos !== FALSE) {
return substr_replace($title, $civicrm_wp_title, $pos, 7);
}
return $civicrm_wp_title;
}
/**
* Override a WordPress page title with the CiviCRM entity title
* Callback method for 'single_page_title' hook, always called from WP front-end
*
* @param string $post_title The title of the WordPress page or post
* @param object $post The WordPress post object the title applies to
* @return string $civicrm_wp_title The title of the CiviCRM entity
*/
public function single_page_title( $post_title, $post ) {
// sanity check and override
global $civicrm_wp_title;
if (!empty($civicrm_wp_title)) {
return $civicrm_wp_title;
}
// fallback
return $post_title;
}
/**
* Remove edit link from page content
* Callback from 'edit_post_link' hook
*
* @return string Always empty
*/
public function clear_edit_post_link() {
return '';
}
/**
* Remove edit link in WP Admin Bar
* Callback from 'wp_before_admin_bar_render' hook
*
* @return void
*/
public function clear_edit_post_menu_item() {
// access object
global $wp_admin_bar;
// bail if in admin
if ( is_admin() ) return;
// remove the menu item from front end
$wp_admin_bar->remove_menu( 'edit' );
}
/**
* Clone of CRM_Utils_System_WordPress::getBaseUrl() whose access is set to
* private. Until it is public, we cannot access the URL of the basepage since
* CRM_Utils_System_WordPress::url()
*
* 27-09-2016
* CRM-16421 CRM-17633 WIP Changes to support WP in it's own directory
* https://wiki.civicrm.org/confluence/display/CRM/WordPress+installed+in+its+own+directory+issues
* For now leave hard coded wp-admin references.
* TODO: remove wp-admin references and replace with admin_url() in the future. Look at best way to get path to admin_url
*
* @param bool $absolute Passing TRUE prepends the scheme and domain, FALSE doesn't
* @param bool $frontend Passing FALSE returns the admin URL
* @param $forceBackend Passing TRUE overrides $frontend and returns the admin URL
* @return mixed|null|string
*/
public function get_base_url($absolute, $frontend, $forceBackend) {
return Civi::paths()->getUrl('[wp.backend]/.', $absolute ? 'absolute' : 'relative');
else {
return Civi::paths()->getUrl('[wp.frontend]/.', $absolute ? 'absolute' : 'relative');
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
}
}
} // class CiviCRM_For_WordPress ends
/*
--------------------------------------------------------------------------------
Procedures start here
--------------------------------------------------------------------------------
*/
/**
* The main function responsible for returning the CiviCRM_For_WordPress instance
* to functions everywhere.
*
* Use this function like you would a global variable, except without needing
* to declare the global.
*
* Example: $civi = civi_wp();
*
* @return CiviCRM_For_WordPress instance
*/
function civi_wp() {
return CiviCRM_For_WordPress::singleton();
}
/**
* Hook CiviCRM_For_WordPress early onto the 'plugins_loaded' action.
*
* This gives all other plugins the chance to load before CiviCRM, to get their
* actions, filters, and overrides setup without CiviCRM being in the way.
*/
if ( defined( 'CIVICRM_LATE_LOAD' ) ) {
add_action( 'plugins_loaded', 'civi_wp', (int) CIVICRM_LATE_LOAD );
// initialize
} else {
civi_wp();
}
/**
* Tell WordPress to call plugin activation method - no longer calls legacy
* global scope function
*/
register_activation_hook( CIVICRM_PLUGIN_FILE, array( civi_wp(), 'activate' ) );
/**
* Tell WordPress to call plugin deactivation method - needed in order to reset
* the option that is set on activation.
*/
register_deactivation_hook( CIVICRM_PLUGIN_FILE, array( civi_wp(), 'deactivate' ) );
// uninstall uses the 'uninstall.php' method
// see: http://codex.wordpress.org/Function_Reference/register_uninstall_hook
/*
--------------------------------------------------------------------------------
The global scope functions below are to maintain backwards compatibility with
previous versions of the CiviCRM WordPress plugin.
--------------------------------------------------------------------------------
*/
/**
* add CiviCRM access capabilities to WordPress roles
* Called by postProcess() in civicrm/CRM/ACL/Form/WordPress/Permissions.php
* Also a callback for the 'init' hook in civi_wp()->register_hooks()
*/
function wp_civicrm_capability() {
civi_wp()->users->set_access_capabilities();
}
/**
* Test if CiviCRM is currently being displayed in WordPress
* Called by setTitle() in civicrm/CRM/Utils/System/WordPress.php
* Also called at the top of this plugin file to determine AJAX status
*/
function civicrm_wp_in_civicrm() {
return civi_wp()->civicrm_in_wordpress();
}
/**
* This was the original name of the initialization function and is
* retained for backward compatibility
*/
function civicrm_wp_initialize() {
return civi_wp()->initialize();
}
/**
* Initialize CiviCRM. Call this function from other modules too if
* they use the CiviCRM API.
*/
function civicrm_initialize() {
return civi_wp()->initialize();
}
/**
* Callback from 'edit_post_link' hook to remove edit link in civicrm_set_post_blank()
*/
function civicrm_set_blank() {
return civi_wp()->clear_edit_post_link();
}
/**
* Authentication function used by civicrm_wp_frontend()
*/
function civicrm_check_permission( $args ) {
return civi_wp()->users->check_permission( $args );
}
/**
* Called when authentication fails in civicrm_wp_frontend()
*/
function civicrm_set_frontendmessage() {
return civi_wp()->users->get_permission_denied();
}
/**
* Invoke CiviCRM in a WordPress context
* Callback function from add_menu_page()
* Callback from WordPress 'init' and 'the_content' hooks
* Also used by civicrm_wp_shortcode_includes() and _civicrm_update_user()
*/
function civicrm_wp_invoke() {
civi_wp()->invoke();
}
/**
* Method that runs only when civicrm plugin is activated.
*/
function civicrm_activate() {
civi_wp()->activate();
}
/**
* Function to create anonymous_user' role, if 'anonymous_user' role is not in the wordpress installation
* and assign minimum capabilities for all wordpress roles
* This function is called on plugin activation and also from upgrade_4_3_alpha1()
*/
function civicrm_wp_set_capabilities() {
civi_wp()->users->set_wp_user_capabilities();
}
/**
* Callback function for add_options_page() that runs the CiviCRM installer
*/
function civicrm_run_installer() {
civi_wp()->run_installer();
}
/**
* Function to get the contact type
* @param string $default contact type
* @return $ctype contact type
*/
function civicrm_get_ctype( $default = NULL ) {
return civi_wp()->users->get_civicrm_contact_type( $default );
}
/**
* Getter function for global $wp_set_breadCrumb
* Called by appendBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
*/
function wp_get_breadcrumb() {
global $wp_set_breadCrumb;
return $wp_set_breadCrumb;
}
/**
* Setter function for global $wp_set_breadCrumb
* Called by appendBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
* Called by resetBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
*/
function wp_set_breadcrumb( $breadCrumb ) {
global $wp_set_breadCrumb;
$wp_set_breadCrumb = $breadCrumb;
return $wp_set_breadCrumb;
}
/**
* Incorporate WP-CLI Integration
* Based on drush civicrm functionality, work done by Andy Walker
* https://github.com/andy-walker/wp-cli-civicrm
*/
if ( defined('WP_CLI') && WP_CLI ) {
// changed from __DIR__ because of possible symlink issues
include_once CIVICRM_PLUGIN_DIR . 'wp-cli/civicrm.php';
}