eventespresso / event-espresso-core

core/admin/PostShortcodeTracking.php

Doc Comments +1 added lines, -1 removed lines

@@ -256,7 +256,7 @@
 	 * @param  int $ID
 	 * @param      $shortcode_class
 	 * @param      $shortcode_posts
-	 * @param      $page_for_posts
+	 * @param      string $page_for_posts
 	 * @param bool $update_post_shortcodes
 	 * @return bool
 	 */

Spacing +84 added lines, -84 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace EventEspresso\core\admin;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -28,31 +28,31 @@ 
 	public static function set_hooks_admin() {
 		add_action(
 			'save_post',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'parse_post_content_on_save' ),
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'parse_post_content_on_save'),
 			10,
 			2
 		);
 		add_action(
 			'delete_post',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'unset_post_shortcodes_on_delete' ),
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'unset_post_shortcodes_on_delete'),
 			100,
 			1
 		);
 		add_action(
 			'add_option_page_for_posts',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_initial_set' ),
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_initial_set'),
 			100,
 			2
 		);
 		add_action(
 			'update_option',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_change' ),
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_change'),
 			100,
 			3
 		);
 		add_action(
 			'delete_option',
-			array( 'EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_delete' ),
+			array('EventEspresso\core\admin\PostShortcodeTracking', 'reset_page_for_posts_on_delete'),
 			100,
 			1
 		);
@@ -72,64 +72,64 @@ 
 	 * @param \WP_Post $post
 	 * @return    void
 	 */
-	public static function parse_post_content_on_save( $post_ID, $post ) {
+	public static function parse_post_content_on_save($post_ID, $post) {
 		// if the post is trashed, then let's remove our post shortcode tracking
-		if ( $post instanceof \WP_Post && $post->post_status === 'trash' ) {
-			PostShortcodeTracking::unset_post_shortcodes_on_delete( $post_ID );
+		if ($post instanceof \WP_Post && $post->post_status === 'trash') {
+			PostShortcodeTracking::unset_post_shortcodes_on_delete($post_ID);
 			return;
 		}
 		// default post types
 		$post_types = (array) apply_filters(
 			'FHEE__EventEspresso_core_admin_PostShortcodeTracking__parse_post_content_on_save__default_post_types',
-			array( 'post' => 0, 'page' => 1 )
+			array('post' => 0, 'page' => 1)
 		);
 		// add CPTs
 		$CPTs = \EE_Register_CPTs::get_CPTs();
-		$post_types = array_merge( $post_types, $CPTs );
+		$post_types = array_merge($post_types, $CPTs);
 		// for default or CPT posts...
-		if ( isset( $post_types[ $post->post_type ] ) ) {
+		if (isset($post_types[$post->post_type])) {
 			// post on frontpage ?
 			$page_for_posts = \EE_Config::get_page_for_posts();
-			if ( $post->post_name === $page_for_posts ) {
-				PostShortcodeTracking::set_post_shortcodes_for_posts_page( $page_for_posts );
+			if ($post->post_name === $page_for_posts) {
+				PostShortcodeTracking::set_post_shortcodes_for_posts_page($page_for_posts);
 				return;
 			}
 			// array of shortcodes indexed by post name
-			\EE_Registry::CFG()->core->post_shortcodes = isset( \EE_Registry::CFG()->core->post_shortcodes )
+			\EE_Registry::CFG()->core->post_shortcodes = isset(\EE_Registry::CFG()->core->post_shortcodes)
 				? \EE_Registry::CFG()->core->post_shortcodes
 				: array();
 			// whether to proceed with update
 			$update_post_shortcodes = false;
 			// empty both arrays
-			\EE_Registry::CFG()->core->post_shortcodes[ $post->post_name ] = array();
+			\EE_Registry::CFG()->core->post_shortcodes[$post->post_name] = array();
 			// check that posts page is already being tracked
-			if ( ! isset( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ] ) ) {
+			if ( ! isset(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts])) {
 				// if not, then ensure that it is properly added
-				\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ] = array();
+				\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts] = array();
 			}
 			// loop thru shortcodes
-			foreach ( \EE_Registry::instance()->shortcodes as $EES_Shortcode => $shortcode_dir ) {
+			foreach (\EE_Registry::instance()->shortcodes as $EES_Shortcode => $shortcode_dir) {
 				// convert to UPPERCASE to get actual shortcode
-				$EES_Shortcode = strtoupper( $EES_Shortcode );
+				$EES_Shortcode = strtoupper($EES_Shortcode);
 				// is the shortcode in the post_content ?
-				if ( strpos( $post->post_content, $EES_Shortcode ) !== false ) {
+				if (strpos($post->post_content, $EES_Shortcode) !== false) {
 					// map shortcode to post names and post IDs
-					\EE_Registry::CFG()->core->post_shortcodes[ $post->post_name ][ $EES_Shortcode ] = $post_ID;
+					\EE_Registry::CFG()->core->post_shortcodes[$post->post_name][$EES_Shortcode] = $post_ID;
 					// and add this shortcode to the tracking for the blog page
-					PostShortcodeTracking::set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID );
+					PostShortcodeTracking::set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID);
 					$update_post_shortcodes = true;
 				} else {
 					// shortcode is not present in post content, so check if we were tracking it previously
 					// stop tracking if shortcode is not used in this specific post
-					if ( isset( \EE_Registry::CFG()->core->post_shortcodes[ $post->post_name ][ $EES_Shortcode ] ) ) {
-						unset( \EE_Registry::CFG()->core->post_shortcodes[ $post->post_name ][ $EES_Shortcode ] );
+					if (isset(\EE_Registry::CFG()->core->post_shortcodes[$post->post_name][$EES_Shortcode])) {
+						unset(\EE_Registry::CFG()->core->post_shortcodes[$post->post_name][$EES_Shortcode]);
 						$update_post_shortcodes = true;
 					}
 					// make sure that something is set for the shortcode posts (even though we may remove this)
 					$shortcode_posts = isset(
-						\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ]
+						\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode]
 					)
-						? \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ]
+						? \EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode]
 						: array();
 					// and stop tracking for this shortcode on the blog page if it is not used
 					$update_post_shortcodes = PostShortcodeTracking::unset_posts_page_shortcode_for_post(
@@ -143,8 +143,8 @@ 
 						: $update_post_shortcodes;
 				}
 			}
-			if ( $update_post_shortcodes ) {
-				PostShortcodeTracking::update_post_shortcodes( $page_for_posts );
+			if ($update_post_shortcodes) {
+				PostShortcodeTracking::update_post_shortcodes($page_for_posts);
 			}
 		}
 	}
@@ -161,15 +161,15 @@ 
 	 * @param  string $page_for_posts
 	 * @return void
 	 */
-	protected static function set_post_shortcodes_for_posts_page( $page_for_posts ) {
-		\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ] = array();
+	protected static function set_post_shortcodes_for_posts_page($page_for_posts) {
+		\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts] = array();
 		// loop thru shortcodes
-		foreach ( \EE_Registry::CFG()->core->post_shortcodes as $post_name => $post_shortcodes ) {
-			foreach ( $post_shortcodes as $EES_Shortcode => $post_ID ) {
-				PostShortcodeTracking::set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID );
+		foreach (\EE_Registry::CFG()->core->post_shortcodes as $post_name => $post_shortcodes) {
+			foreach ($post_shortcodes as $EES_Shortcode => $post_ID) {
+				PostShortcodeTracking::set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID);
 			}
 		}
-		PostShortcodeTracking::update_post_shortcodes( $page_for_posts );
+		PostShortcodeTracking::update_post_shortcodes($page_for_posts);
 	}
 
 
@@ -184,24 +184,24 @@ 
 	 * @param         $EES_Shortcode
 	 * @param         $post_ID
 	 */
-	protected static function set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID ) {
+	protected static function set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID) {
 		// critical page shortcodes that we do NOT want added to the Posts page (blog)
 		$critical_shortcodes = \EE_Registry::CFG()->core->get_critical_pages_shortcodes_array();
 		// if the shortcode is NOT one of the critical page shortcodes like ESPRESSO_TXN_PAGE
-		if ( in_array( $EES_Shortcode, $critical_shortcodes ) ) {
+		if (in_array($EES_Shortcode, $critical_shortcodes)) {
 			return;
 		}
 		// add shortcode to "Posts page" tracking
-		if ( isset( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] ) ) {
+		if (isset(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode])) {
 			// make sure tracking is in form of an array
-			if ( ! is_array( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] ) ) {
-				\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] = array(
-					\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] => true
+			if ( ! is_array(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode])) {
+				\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode] = array(
+					\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode] => true
 				);
 			}
-			\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] += array( $post_ID => true );
+			\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode] += array($post_ID => true);
 		} else {
-			\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $EES_Shortcode ] = array( $post_ID => true );
+			\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$EES_Shortcode] = array($post_ID => true);
 		}
 	}
 
@@ -214,16 +214,16 @@ 
 	 * @param  int $ID
 	 * @return void
 	 */
-	public static function unset_post_shortcodes_on_delete( $ID ) {
+	public static function unset_post_shortcodes_on_delete($ID) {
 		$update_post_shortcodes = false;
 		// post on frontpage ?
 		$page_for_posts = \EE_Config::get_page_for_posts();
 		// looking for any references to this post
-		foreach ( \EE_Registry::CFG()->core->post_shortcodes as $post_name => $post_shortcodes ) {
+		foreach (\EE_Registry::CFG()->core->post_shortcodes as $post_name => $post_shortcodes) {
 			// is this the "Posts Page" (blog) ?
-			if ( $post_name === $page_for_posts ) {
+			if ($post_name === $page_for_posts) {
 				// loop thru shortcodes registered for the posts page
-				foreach ( $post_shortcodes as $shortcode_class => $shortcode_posts ) {
+				foreach ($post_shortcodes as $shortcode_class => $shortcode_posts) {
 					$update_post_shortcodes = PostShortcodeTracking::unset_posts_page_shortcode_for_post(
 						$ID,
 						$shortcode_class,
@@ -236,17 +236,17 @@ 
 				}
 			} else {
 				// loop thru shortcodes registered for each page
-				foreach ( $post_shortcodes as $shortcode_class => $post_ID ) {
+				foreach ($post_shortcodes as $shortcode_class => $post_ID) {
 					// if this is page is being deleted, then don't track any post shortcodes for it
-					if ( $post_ID === $ID ) {
-						unset( \EE_Registry::CFG()->core->post_shortcodes[ $post_name ] );
+					if ($post_ID === $ID) {
+						unset(\EE_Registry::CFG()->core->post_shortcodes[$post_name]);
 						$update_post_shortcodes = true;
 					}
 				}
 			}
 		}
-		if ( $update_post_shortcodes ) {
-			PostShortcodeTracking::update_post_shortcodes( $page_for_posts );
+		if ($update_post_shortcodes) {
+			PostShortcodeTracking::update_post_shortcodes($page_for_posts);
 		}
 	}
 
@@ -271,20 +271,20 @@ 
 		$update_post_shortcodes = false
 	) {
 		// make sure that an array of post IDs is being tracked for each  shortcode
-		if ( ! is_array( $shortcode_posts ) ) {
-			\EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $shortcode_class ] = array(
+		if ( ! is_array($shortcode_posts)) {
+			\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$shortcode_class] = array(
 				$shortcode_posts => true
 			);
 			$update_post_shortcodes = true;
 		}
 		// now if the ID of the post being deleted is in the $shortcode_posts array
-		if ( is_array( $shortcode_posts ) && isset( $shortcode_posts[ $ID ] ) ) {
-			unset( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $shortcode_class ][ $ID ] );
+		if (is_array($shortcode_posts) && isset($shortcode_posts[$ID])) {
+			unset(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$shortcode_class][$ID]);
 			$update_post_shortcodes = true;
 		}
 		// if nothing is registered for that shortcode anymore, then delete the shortcode altogether
-		if ( empty( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $shortcode_class ] ) ) {
-			unset( \EE_Registry::CFG()->core->post_shortcodes[ $page_for_posts ][ $shortcode_class ] );
+		if (empty(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$shortcode_class])) {
+			unset(\EE_Registry::CFG()->core->post_shortcodes[$page_for_posts][$shortcode_class]);
 			$update_post_shortcodes = true;
 		}
 		return $update_post_shortcodes;
@@ -299,9 +299,9 @@ 
 	 * @param $page_for_posts
 	 * @return    void
 	 */
-	public static function update_post_shortcodes( $page_for_posts = '' ) {
+	public static function update_post_shortcodes($page_for_posts = '') {
 		// make sure page_for_posts is set
-		$page_for_posts = ! empty( $page_for_posts )
+		$page_for_posts = ! empty($page_for_posts)
 			? $page_for_posts
 			: \EE_Config::get_page_for_posts();
 		// allow others to mess stuff up :D
@@ -317,45 +317,45 @@ 
 			$page_for_posts
 		);
 		// verify that post_shortcodes is set
-		\EE_Config::instance()->core->post_shortcodes = isset( \EE_Config::instance()->core->post_shortcodes )
-		                                                && is_array( \EE_Config::instance()->core->post_shortcodes )
+		\EE_Config::instance()->core->post_shortcodes = isset(\EE_Config::instance()->core->post_shortcodes)
+		                                                && is_array(\EE_Config::instance()->core->post_shortcodes)
 			? \EE_Config::instance()->core->post_shortcodes
 			: array();
 		// cycle thru post_shortcodes
-		foreach ( \EE_Config::instance()->core->post_shortcodes as $post_name => $shortcodes ) {
+		foreach (\EE_Config::instance()->core->post_shortcodes as $post_name => $shortcodes) {
 			// are there any shortcodes to track ?
-			if ( ! empty( $shortcodes ) ) {
+			if ( ! empty($shortcodes)) {
 				// loop thru list of tracked shortcodes
-				foreach ( $shortcodes as $shortcode => $post_id ) {
+				foreach ($shortcodes as $shortcode => $post_id) {
 					// if shortcode is for a critical page,
 					// BUT this is NOT the corresponding critical page for that shortcode
-					if ( $post_name === $page_for_posts ) {
+					if ($post_name === $page_for_posts) {
 						continue;
 					}
 					// skip the posts page, because we want all shortcodes registered for it
-					if ( $post_name === $page_for_posts ) {
+					if ($post_name === $page_for_posts) {
 						continue;
 					}
 					// make sure post still exists
-					$post = get_post( $post_id );
+					$post = get_post($post_id);
 					// check that the post name matches what we have saved
-					if ( $post && $post->post_name === $post_name ) {
+					if ($post && $post->post_name === $post_name) {
 						// if so, then break before hitting the unset below
 						continue;
 					}
 					// we don't like missing posts around here >:(
-					unset( \EE_Config::instance()->core->post_shortcodes[ $post_name ] );
+					unset(\EE_Config::instance()->core->post_shortcodes[$post_name]);
 				}
 			} else {
 				// you got no shortcodes to keep track of !
-				unset( \EE_Config::instance()->core->post_shortcodes[ $post_name ] );
+				unset(\EE_Config::instance()->core->post_shortcodes[$post_name]);
 			}
 		}
 		// critical page shortcodes that we do NOT want added to the Posts page (blog)
 		$critical_shortcodes = \EE_Config::instance()->core->get_critical_pages_shortcodes_array();
-		$critical_shortcodes = array_flip( $critical_shortcodes );
-		foreach ( $critical_shortcodes as $critical_shortcode ) {
-			unset( \EE_Config::instance()->core->post_shortcodes[ $page_for_posts ][ $critical_shortcode ] );
+		$critical_shortcodes = array_flip($critical_shortcodes);
+		foreach ($critical_shortcodes as $critical_shortcode) {
+			unset(\EE_Config::instance()->core->post_shortcodes[$page_for_posts][$critical_shortcode]);
 		}
 		//only show errors
 		\EE_Config::instance()->update_espresso_config();
@@ -375,8 +375,8 @@ 
 	 * @param  string $value
 	 * @return void
 	 */
-	public static function reset_page_for_posts_on_initial_set( $option, $value ) {
-		PostShortcodeTracking::reset_page_for_posts_on_change( $option, '', $value );
+	public static function reset_page_for_posts_on_initial_set($option, $value) {
+		PostShortcodeTracking::reset_page_for_posts_on_change($option, '', $value);
 	}
 
 
@@ -393,13 +393,13 @@ 
 	 * @param  string $value
 	 * @return void
 	 */
-	public static function reset_page_for_posts_on_change( $option, $old_value = '', $value = '' ) {
-		if ( $option === 'page_for_posts' ) {
+	public static function reset_page_for_posts_on_change($option, $old_value = '', $value = '') {
+		if ($option === 'page_for_posts') {
 			global $wpdb;
 			$table = $wpdb->posts;
 			$SQL = "SELECT post_name from $table WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-			$new_page_for_posts = $value ? $wpdb->get_var( $wpdb->prepare( $SQL, $value ) ) : 'posts';
-			PostShortcodeTracking::set_post_shortcodes_for_posts_page( $new_page_for_posts );
+			$new_page_for_posts = $value ? $wpdb->get_var($wpdb->prepare($SQL, $value)) : 'posts';
+			PostShortcodeTracking::set_post_shortcodes_for_posts_page($new_page_for_posts);
 		}
 	}
 
@@ -415,9 +415,9 @@ 
 	 * @param  string $option
 	 * @return void
 	 */
-	public static function reset_page_for_posts_on_delete( $option ) {
-		if ( $option === 'page_for_posts' ) {
-			PostShortcodeTracking::set_post_shortcodes_for_posts_page( 'posts' );
+	public static function reset_page_for_posts_on_delete($option) {
+		if ($option === 'page_for_posts') {
+			PostShortcodeTracking::set_post_shortcodes_for_posts_page('posts');
 		}
 	}