ictuwp-plugin-community-taxonomie.php

<?php

/**
 * @link                https://github.com/ICTU/ictuwp-plugin-community-taxonomie
 * @package             ictuwp-plugin-community-taxonomie
 *
 * @wordpress-plugin
 * Plugin Name:         ICTU / Gebruiker Centraal / Community taxonomie
 * Plugin URI:          https://github.com/ICTU/ictuwp-plugin-community-taxonomie
 * Description:         Plugin voor het aanmaken van de 'community'-taxonomie
 * Version:             2.2.1
 * Version description: Allow NULL for community_taxonomy_page.
 * Author:              David Hund
 * Author URI:          https://github.com/ICTU/ictuwp-plugin-community-taxonomie/
 * License:             GPL-3.0+
 * License URI:         http://www.gnu.org/licenses/gpl-3.0.txt
 * Text Domain:         gctheme
 * Domain Path:         /languages
 */

// If this file is called directly, abort.
if ( ! defined( 'WPINC' ) ) {
	die;
}

//========================================================================================================
defined( 'GC_COMMUNITY_TAX' ) or define( 'GC_COMMUNITY_TAX', 'community' );
defined( 'GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE' ) or define( 'GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE', 'template-overview-communities.php' );
defined( 'GC_COMMUNITY_TAX_DETAIL_TEMPLATE' ) or define( 'GC_COMMUNITY_TAX_DETAIL_TEMPLATE', 'template-detail-communities.php' );
defined( 'GC_COMMUNITY_TAX_POSTS_ARCHIVE_TEMPLATE' ) or define( 'GC_COMMUNITY_TAX_POSTS_ARCHIVE_TEMPLATE', 'template-posts-communities.php' );
defined( 'GC_COMMUNITY_TAX_ASSETS_PATH' ) or define( 'GC_COMMUNITY_TAX_ASSETS_PATH' , '/wp-content/plugins/ictuwp-plugin-community-taxonomie/assets' );
//========================================================================================================
// only this plugin should activate the GC_COMMUNITY_TAX taxonomy
if ( ! taxonomy_exists( GC_COMMUNITY_TAX ) ) {
	add_action( 'plugins_loaded', array( 'ICTU_GC_community_taxonomy', 'init' ), 10 );
}


//========================================================================================================

/**
 * Begins execution of the plugin.
 *
 * Since everything within the plugin is registered via hooks,
 * then kicking off the plugin from this point in the file does
 * not affect the page life cycle.
 *
 * @since    1.0.0
 */


if ( ! class_exists( 'ICTU_GC_community_taxonomy' ) ) :

	class ICTU_GC_community_taxonomy {

		/** ----------------------------------------------------------------------------------------------------
		 * Init
		 */
		public static function init() {

			$newtaxonomy = new self();

		}

		/** ----------------------------------------------------------------------------------------------------
		 * Constructor
		 */
		public function __construct() {

			$this->fn_ictu_community_setup_actions();

		}

		/** ----------------------------------------------------------------------------------------------------
		 * Hook this plugins functions into WordPress.
		 * Use priority = 20, to ensure that the taxonomy is registered for post types from other plugins,
		 * such as the podcasts plugin (seriously-simple-podcasting)
		 */
		private function fn_ictu_community_setup_actions() {

			add_action( 'init', array( $this, 'fn_ictu_community_register_taxonomy' ), 20 );

			// add page templates
			add_filter( 'template_include', array( $this, 'fn_ictu_community_append_template_locations' ) );

			// filter the breadcrumbs
			add_filter( 'wpseo_breadcrumb_links', array( $this, 'fn_ictu_community_yoast_filter_breadcrumb' ) );

			// check if the term has detail page attached
			add_action( 'template_redirect', array( $this, 'fn_ictu_community_check_redirect' ) );

			// Hide the `metabox_posts_category` field for 'community' related posts
			// (because we already filter on Community tax term)
			add_filter( 'acf/prepare_field/name=metabox_posts_category', function ( $field ) {
				global $post;
				if ( ! empty( $post ) ) {
					// Check if we're currently editing a post
					// with a Community template.
					// If so: *disable* the category selection (return false)
					// because we use the Community Tax...
					$page_template = get_post_meta( $post->ID, '_wp_page_template', true );
					if ( $page_template === GC_COMMUNITY_TAX_DETAIL_TEMPLATE ) {
						return false;
					}
				}

				return $field;
			} );

			// Update the default value of the automatic link text field from 'categorie' to 'community'
			// add_filter( 'acf/prepare_field/name=metabox_posts_archive_selection_automatic_link_text', function( $field ) {
			// 	if ( empty( $field['value'] ) || empty( $field['default_value'] ) ) {
			// 		return $field;
			// 	}

			// 	if ( $field['value'] === $field['default_value'] ) {
			// 		$new_default_value     = str_replace( 'categorie', GC_COMMUNITY_TAX, $field['default_value'] );
			// 		$field['default_value'] = $new_default_value;
			// 		$field['value']         = $new_default_value;
			// 	}
			// 	return $field;
			// } );

			/**
			 * Filter the main query for Community Taxonomy Term Archives
			 * Update the `post_type` to only include `post` type.
			 *
			 * @param WP_Query $query
			 */

			// NOTE: not needed because we use a separate page template
			// for the Community Taxonomy Term POST Archives

			// function community_term_archive_query_posts_only( $query ) {
			// 	if ( ! is_admin() && $query->is_main_query() ) {
			// 		// Not a query for an admin page.
			// 		// It's the main query for a front end page of your site.
			// 		if ( is_tax( GC_COMMUNITY_TAX ) ) {
			// 			// It's the main query for a community tax term archive.
			// 			// Now only include POSTS
			// 			$query->set( 'post_type', array( 'post' ) );
			// 		}
			// 	}
			// }
			// add_action( 'pre_get_posts', 'community_term_archive_query_posts_only' );

		}


		/** ----------------------------------------------------------------------------------------------------
		 * Do actually register the post types we need
		 *
		 * @return void
		 */
		public function fn_ictu_community_register_taxonomy() {

			require_once plugin_dir_path( __FILE__ ) . 'includes/community-taxonomy.php';

			// Require all needed ACF fieldgroup fields
			require_once plugin_dir_path( __FILE__ ) . 'includes/community-taxonomy-acf-fields.php';

			// Require all needed ACF fieldgroup fields
			require_once plugin_dir_path( __FILE__ ) . 'includes/community-taxonomy-page-acf-fields.php';

		}


		/**
		 * Checks if the template is assigned to the page
		 *
		 * @in: $template (string)
		 *
		 * @return: $template (string)
		 *
		 */
		public function fn_ictu_community_append_template_locations( $template ) {

			// For SOME reason, we still get a $post object,
			// even if we are on a taxonomy archive page..
			// This messes with the template selection, so we need to check for that
			// and use the default archive template
			// @TODO: investigate/improve this
			// use is_singular() instead?
			if ( is_search() or is_tax( GC_COMMUNITY_TAX ) ) {
				// $term = get_queried_object();
				return $template;
			}

			// Not a taxonomy archive page, so continue as before...

			// Get global post
			global $post;
			$file       = '';
			$pluginpath = plugin_dir_path( __FILE__ );

			if ( $post ) {
				// Do we have a post of whatever kind at hand?
				// Get template name; this will only work for pages, obviously
				$page_template = get_post_meta( $post->ID, '_wp_page_template', true );

				if (
					( GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE === $page_template ) ||
					( GC_COMMUNITY_TAX_DETAIL_TEMPLATE === $page_template ) ||
					( GC_COMMUNITY_TAX_POSTS_ARCHIVE_TEMPLATE === $page_template )
				) {
					// these names are added by this plugin, so we return
					// the actual file path for this template
					$file = $pluginpath . $page_template;
				} else {
					// exit with the already set template
					return $template;
				}
			} else {
				// Not a post, return the template
				return $template;
			}

			// Just to be safe, check if the file actually exists
			if ( $file && file_exists( $file ) ) {
				return $file;
			} else {
				// o dear, who deleted the file?
				echo $file;
			}

			// If all else fails, return template
			return $template;
		}


		/**
		 * Filter the Yoast SEO breadcrumb
		 *
		 * @in: $links (array)
		 *
		 * @return: $links (array)
		 *
		 */
		public function fn_ictu_community_yoast_filter_breadcrumb( $links ) {
			global $post;

			if ( $post && is_page() ) {

				$page_template = get_post_meta( $post->ID, '_wp_page_template', true );

				// Currently Querying a Page
				// Try and see if it has the GC_COMMUNITY_TAX_DETAIL_TEMPLATE template
				// and if so, append the Community Overview Page to the breadcrumb
				// But only if the current page is not a childpage of the parent...
				if ( $post->post_parent !== 0 ) {
					// page does have a parent, whatever parent it might be, so:
					// do nothing extra for breadcrumb

				} else {
					// page does NOT have a parent, so let's add the GC_COMMUNITY_TAX_DETAIL_TEMPLATE to
					if ( $page_template && $page_template === GC_COMMUNITY_TAX_DETAIL_TEMPLATE ) {
						// current page has template = GC_COMMUNITY_TAX_DETAIL_TEMPLATE

						// Get the Community Overview Page to append to our breadcrumb
						$community_overview_page_id = $this->fn_ictu_community_get_community_overview_page();

						if ( $community_overview_page_id ) {
							// We have a Overview-page ID
							// and it is not the parent of the current page
							// Use this page as GC_COMMUNITY_TAX term parent in the breadcrumb
							$taxonomy_link = array(
								'url'  => get_permalink( $community_overview_page_id ),
								'text' => get_the_title( $community_overview_page_id )
							);
							array_splice( $links, - 1, 0, [ $taxonomy_link ] );
						}

					}

				}

				// Are we on the Community Taxonomy Posts Archive Page?
				// If so, add paging number to the breadcrumbs.
				if ( ! isset( $paged ) || empty( $paged ) ) {
					$paged = get_query_var( 'paged' ) ?: 1;
				}
				if ( $paged !== 1 ) {
					// we use pagination and we are not on page 1
					$pagination_text = sprintf( _x( "pagina %s", "Yoast breadcrumb filter", 'gctheme' ), $paged );
					if ( $page_template && $page_template === GC_COMMUNITY_TAX_POSTS_ARCHIVE_TEMPLATE ) {
						$last_item = array_pop( $links );
						// Update `text`
						if ( $last_item['text'] ) {
							$last_item['text'] .= ', ' . $pagination_text;
						} else {
							$last_item['text'] = ' ' . $pagination_text;
						}

						array_push( $links, $last_item );
					}
				}

			} elseif ( is_tax( GC_COMMUNITY_TAX ) ) {

				// NOT currently Querying a Page, but a GC_COMMUNITY_TAX term
				$term = get_queried_object();
				// Append taxonomy if 1st-level child term only
				// old: Home > Term
				// new: Home > Taxonomy > Term

				if ( ! $term->parent ) {

					$community_overview_page_id = $this->fn_ictu_community_get_community_overview_page();

					if ( $community_overview_page_id ) {
						// Use this page as GC_COMMUNITY_TAX term parent in the breadcrumb
						// If not available,
						// - [1] Do not display root
						// - [2] OR fall back to Taxonomy Rewrite

						$taxonomy_link = array(
							'url'  => get_permalink( $community_overview_page_id ),
							'text' => get_the_title( $community_overview_page_id )
						);
						array_splice( $links, - 1, 0, array( $taxonomy_link ) );

					} else {
						// [1] .. do nothing...

						// [2] OR .. use Taxonomy Rewrite as root

						// $taxonomy      = get_taxonomy( GC_COMMUNITY_TAX );
						// $taxonomy_link = [
						// 	'url' => get_home_url() . '/' . $taxonomy->rewrite['slug'],
						// 	'text' => $taxonomy->labels->archives,
						// 	'term_id' => get_queried_object_id(),
						// ];
						// array_splice( $links, -1, 0, [$taxonomy_link] );
					}
				}

			}

			return $links;

		}


		/**
		 * Checks if the community term is linked to a page and redirect
		 *
		 * @return: {Function|null} wp_safe_redirect when possible
		 *
		 */
		public function fn_ictu_community_check_redirect() {

			if ( ! function_exists( 'get_field' ) ) {
				// we can't check if ACF is not active
				return;
			}

			if ( is_tax( GC_COMMUNITY_TAX ) ) {

				// check if the current term has a value for 'community_taxonomy_page'
				$term    = get_queried_object();
				$page_id = get_field( 'community_taxonomy_page', $term );
				if ( ! empty( $page_id ) ) {
					$page = get_post( $page_id );
				}

				// A page is selected for this term
				// But is the page published?
				if ( $page && 'publish' === $page->post_status ) {
					// good: it is published
					// let's redirect to that page
					wp_safe_redirect( get_permalink( $page->ID ) );
					exit;

				} else {
					// bad: we only want published pages
					$aargh = _x( 'Er hangt geen gepubliceerde pagina aan deze community.', 'Warning for redirect error', 'gctheme' );
					if ( current_user_can( 'editor' ) ) {
						$editlink = get_edit_term_link( get_queried_object()->term_id, get_queried_object()->taxonomy );
						$aargh .= '<br>' . sprintf( _x( '<a href="%s">Voeg een gepubliceerde pagina toe, alsjeblieft.</a>', 'Warning for redirect error', 'gctheme' ), $editlink );
					}
					die( $aargh );
				}
			}

		}


		/**
		 * Retrieve a page that is the GC_COMMUNITY_TAX overview page. This
		 * page shows all available GC_COMMUNITY_TAX terms
		 *
		 * @in: $args (array)
		 *
		 * @return: $overview_page_id (integer)
		 *
		 */

		private function fn_ictu_community_get_community_overview_page( $args = array() ) {

			$return = 0;

			// TODO: discuss if we need to make this page a site setting
			// there is no technical way to limit the number of pages with
			// template GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE, so the page we find may not be
			// the exact desired page for in the breadcrumb.
			//
			// Try and find 1 Page
			// with the GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE template...
			$page_template_query_args = array(
				'number'      => 1,
				'sort_column' => 'post_date',
				'sort_order'  => 'DESC',
				'meta_key'    => '_wp_page_template',
				'meta_value'  => GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE
			);
			$overview_page            = get_pages( $page_template_query_args );

			if ( $overview_page && isset( $overview_page[0]->ID ) ) {
				$return = $overview_page[0]->ID;
			}

			return $return;

		}


	}

endif;


//========================================================================================================

/**
 * Load plugin textdomain.
 * only load translations if we can safely assume the taxonomy is active
 */
add_action( 'init', 'fn_ictu_community_load_plugin_textdomain' );

function fn_ictu_community_load_plugin_textdomain() {

	load_plugin_textdomain( 'gctheme', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );

}

//========================================================================================================

/**
 * Returns array of allowed page templates
 *
 * @return array with extra templates
 */
function fn_ictu_community_add_templates() {

	$return_array = array(
		GC_COMMUNITY_TAX_OVERVIEW_TEMPLATE      => _x( '[Community] overzicht', 'label page template', 'gctheme' ),
		GC_COMMUNITY_TAX_DETAIL_TEMPLATE        => _x( '[Community] detailpagina', 'label page template', 'gctheme' ),
		GC_COMMUNITY_TAX_POSTS_ARCHIVE_TEMPLATE => _x( '[Community] artikelen archief', 'label page template', 'gctheme' ),
	);

	return $return_array;

}