civicrm.shortcodes.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC https://civicrm.org/licensing
 *
 */

// This file must not accessed directly.
if (!defined('ABSPATH')) {
  exit;
}

/**
 * Define CiviCRM_For_WordPress_Shortcodes Class.
 *
 * @since 4.6
 */
class CiviCRM_For_WordPress_Shortcodes {

  /**
   * @var object
   * Plugin object reference.
   * @since 4.6
   * @access public
   */
  public $civi;

  /**
   * @var array
   * The stored Shortcodes.
   * @since 4.6
   * @access public
   */
  public $shortcodes = [];

  /**
   * @var array
   * The array of rendered Shortcode markup.
   * @since 4.6
   * @access public
   */
  public $shortcode_markup = [];

  /**
   * @var array
   * Count multiple passes of do_shortcode in a post.
   * @since 4.6
   * @access public
   */
  public $shortcode_in_post = [];

  /**
   * Instance constructor.
   *
   * @since 4.6
   */
  public function __construct() {

    // Store reference to CiviCRM plugin object.
    $this->civi = civi_wp();

  }

  /**
   * Register hooks to handle the presence of Shortcodes in content.
   *
   * @since 4.6
   */
  public function register_hooks() {

    // Register the CiviCRM Shortcode.
    add_shortcode('civicrm', [$this, 'render_single']);

    // Pre-render CiviCRM content when one or more Shortcodes are detected.
    add_action('wp', [$this, 'prerender'], 20, 1);

  }

  /**
   * Determine if a CiviCRM Shortcode is present in any of the posts about to be displayed.
   *
   * Callback method for 'wp' hook, always called from WordPress front-end.
   *
   * @since 4.6
   *
   * @param object $wp The WordPress object, present but not used.
   */
  public function prerender($wp) {

    /*
     * At this point, all conditional tags are available
     * @see https://codex.wordpress.org/Conditional_Tags
     */

    // Bail if this is a 404.
    if (is_404()) {
      return;
    }

    // Bail if this is a Favicon request.
    if (is_favicon()) {
      return;
    }

    // A counter's useful.
    $shortcodes_present = 0;

    /*
     * Let's loop through the results.
     * This also has the effect of bypassing the logic in:
     * @see https://github.com/civicrm/civicrm-wordpress/pull/36
     */
    if (have_posts()) {
      while (have_posts()) {

        the_post();

        global $post;

        // Check for existence of Shortcode in content.
        if (has_shortcode($post->post_content, 'civicrm')) {

          // Get CiviCRM Shortcodes in this post.
          $shortcodes_array = $this->get_for_post($post->post_content);

          // Sanity check.
          if (!empty($shortcodes_array)) {

            // Add it to our property.
            $this->shortcodes[$post->ID] = $shortcodes_array;

            // Bump Shortcode counter.
            $shortcodes_present += count($this->shortcodes[$post->ID]);

          }

        }

      }
    }

    // Reset loop.
    rewind_posts();

    // Bail if there are no Shortcodes.
    if ($shortcodes_present === 0) {
      return;
    }

    // Set context.
    $this->civi->civicrm_context_set('shortcode');

    // Did we get any?
    if ($shortcodes_present) {

      // We need CiviCRM initialised prior to parsing Shortcodes.
      if (!$this->civi->initialize()) {
        return;
      }

      // How should we handle multiple Shortcodes?
      if ($shortcodes_present > 1) {

        // Add CSS resources for front end.
        add_action('wp_enqueue_scripts', [$this->civi, 'front_end_css_load'], 100);

        // Let's add dummy markup.
        foreach ($this->shortcodes as $post_id => $shortcode_array) {

          // Set flag if there are multple Shortcodes in this post.
          $multiple = (count($shortcode_array) > 1) ? 1 : 0;

          foreach ($shortcode_array as $shortcode) {

            // Mimic invoke in multiple Shortcode context.
            $this->shortcode_markup[$post_id][] = $this->render_multiple($post_id, $shortcode, $multiple);

          }

        }

      }
      else {

        // Add core resources for front end.
        add_action('wp', [$this->civi, 'front_end_page_load'], 100);

        /*
         * Since we have only one Shortcode, run the_loop again.