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 = [];

  /**
   * @var array
   * Simple flag to note that Shortcode parsing has occurred.
   * @since 4.6
   * @access public
   */
  public $shortcodes_parsed = FALSE;

  /**
   * 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 (function_exists('is_favicon') && is_favicon()) {
      return;
    }

    /**
     * Filter the Shortcode Components that do not invoke CiviCRM.
     *
     * Shortcodes for Components such as Afform do load CiviCRM resources but do
     * not have a CiviCRM path and are not rendered via the `invoke()` method.
     * We can allow multiple instances of these Shortcodes in a single page load.
     *
     * @since 5.56
     *
     * @param array $components The array of Components that do not invoke CiviCRM.
     */
    $components = apply_filters('civicrm_no_invoke_shortcode_components', ['afform']);

    // Track the Shortcodes for Components that do and do not invoke CiviCRM.
    $no_invoke_shortcodes = [];
    $total_no_invoke_shortcodes = 0;
    $invoke_shortcodes = [];
    $total_invoke_shortcodes = 0;

    // Track the total number of CiviCRM Shortcodes.
    $total_shortcodes = 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;

        /**
         * Filters the Post content.
         *
         * @since 5.75
         *
         * @param string $post_content The Post content.
         * @param WP_Post $post The WordPress Post object.
         */
        $post->post_content = apply_filters('civicrm_prerender_post_content', $post->post_content, $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 collection of Shortcodes.
            $this->shortcodes[$post->ID] = $shortcodes_array;

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

            // Check for Components that do not invoke CiviCRM.
            foreach ($shortcodes_array as $key => $shortcode) {
              $atts = $this->get_atts($shortcode);
              if (!empty($atts['component']) && in_array($atts['component'], $components)) {
                $no_invoke_shortcodes[$post->ID][$key] = $shortcode;
                $total_no_invoke_shortcodes++;
              }
              else {
                $invoke_shortcodes[$post->ID][$key] = $shortcode;
                $total_invoke_shortcodes++;
              }
            }

          }

        }

      }