Theme integration

Hi,

I wanted to have the functionality to use this plugin in my custom theme I was creating. Without making a complete installation step.

For that reason I installed this functionality:
https://tgmpluginactivation.com/
giving the user the suggestion to install:
Custom Global Variables

Because I didn’t want the user to manually add the different variables I made some changes to the class Custom_Global_Variables

Usually I try to use Github to push changes, but couldn’t find a GIT repository

The complete file:

<?php
/**
 * Plugin Name: Custom Global Variables
 * Plugin URI: https://www.konnectdigital.com.au
 * Description: Easily create custom variables that can be accessed globally in WordPress and PHP. Retrieval of information is extremely fast, with no database calls.
 * Version: 1.0.4
 * Author: Abdullah Khalfan
 * Author URI: https://www.konnectdigital.com.au
 * License: GPL2
 */

define('CustomGlobalVariables', NULL);

class Custom_Global_Variables {

	private $file_path = '';

	// Constructor
	function __construct($external_use = false) {

		$this->file_path = WP_CONTENT_DIR . '/custom-global-variables/' . md5( AUTH_KEY ) . '.json';

		/* Retrieve locally the current definitions. */

		if ( file_exists( $this->file_path ) ) {

			$vars = file_get_contents( $this->file_path );

			if ( ! empty( $vars ) ) {

				$GLOBALS['cgv'] = json_decode( $vars, true );
			}
			else {

				$GLOBALS['cgv'] = array();
			}
		}
		// Create the directory and file when it doesn't exist.
		else {

			if ( wp_mkdir_p( WP_CONTENT_DIR . '/custom-global-variables' ) ) {

				file_put_contents( $this->file_path, '' );
			}

			$GLOBALS['cgv'] = array();
		}

		if(!$external_use) {
			// Add the menu item.
			add_action( 'admin_menu', array( &$this, 'add_menu' ) );

			// Setup the shortcode.
			add_shortcode( 'cgv', array( &$this, 'shortcode' ) );
		}
	}

	// Adds the menu item under Settings
	function add_menu() {

		add_submenu_page(
			'options-general.php',
			'Custom Global Variables',
			'Custom Global Variables',
			'manage_options',
			'custom-global-variables',
			array( &$this, 'admin_page' )
		);
	}

	function save_vars($new_vars = array(), $update = true) {
		$old_vars = $GLOBALS['cgv'];
		$vars = array();

		// Create vars if not exist
		if ( !$update ) {

			foreach ( $new_vars as $name => $val ) {
				
				if( isset( $old_vars[$name] ) ) {

					$vars[$name] = $old_vars[$name];
				} else {
					
					$vars[$name] = $val;
				}
			}
		} else {
			$vars = $new_vars;
		}

		if ( file_put_contents( $this->file_path, json_encode( $vars ) ) !== false ) {

			return true;
		} else {

			return false;
		}
	}

	// Admin page
	function admin_page() {

		// Terminate if the user isn't allowed to access the page.
		if ( ! current_user_can( 'manage_options' ) ) {

			wp_die( 'You do not have sufficient permissions.' );
		}

		wp_enqueue_style( 'custom-global-variables-style', plugins_url( 'style.css', __FILE__ ) );
		wp_enqueue_script( 'custom-global-variables-script', plugins_url( 'script.js', __FILE__ ), array( 'jquery' ) );

		$vars = $GLOBALS['cgv'];

		// Save definitions upon submission.
		if ( isset( $_POST['vars'] ) ) {

			$vars_new = array();

			foreach ( $_POST['vars'] as $var ) {

				if ( ! empty( $var['name'] ) && !empty( $var['val'] ) ) {

					$name = trim( strtolower( str_replace( ' ', '_', $var['name'] ) ) );
					$vars_new[ $name ] = stripslashes( $var['val'] );
				}
			}

			if ( $this->save_vars( $vars_new ) ) {

				$vars = $vars_new;
			
				echo '<div id="message" class="updated"><p>Your variables have successfully been saved.</p></div>';
			}
			else {

				echo '<div id="message" class="error"><p>Your variables could not be saved. Check to see if the following folder exists and has sufficient write permissions:</p><p><strong>' . WP_CONTENT_DIR . '/custom-global-variables' . '</strong></p></div>';
			}
		}
		?>

		<div class="wrap">

			<h2>Custom Global Variables</h2>

			<div class="card">

				<h3>Usage</h3>

				<p>Display your variables using the shortcode syntax:</p>

				<p><code>[cgv <em>variable-name</em>]</code></p>

				<p>Or using the superglobal in PHP:</p>

				<p><code><?php echo $GLOBALS['cgv']['<em>variable-name</em>'] ?></code></p>

			</div>
	 
			<div class="card">

				<h3>Define your variables</h3>

				<form method="POST" action="">

					<table id="custom-global-variables-table-definitions">

						<tbody>

							<?php
							$i = 0;

							if ( !empty( $vars ) ):
							?>

								<?php foreach ( $vars as $key => $val ):  ?>

									<tr>

										<td><input autocomplete="off" name="vars[<?php echo $i ?>][name]" placeholder="name" type="text" value="<?php echo $key ?>"></td>

										<td><span class="equals">=</span></td>

										<td class="value-input">

											<?php if ( $val == strip_tags( $val ) ): ?>

												<input autocomplete="off" name="vars[<?php echo $i ?>][val]" placeholder="value" type="text" value="<?php echo htmlentities( $val ) ?>">

											<?php else: ?>

												<textarea name="vars[<?php echo $i ?>][val]" placeholder="value"><?php echo htmlentities( $val ) ?></textarea>

											<?php endif ?>

										</td>

										<td class="options">

											<img alt="delete" class="delete" src="<?php echo plugin_dir_url( __FILE__ ) ?>/delete.png">

										</td>

									</tr>

								<?php $i++; endforeach; ?>

							<?php endif ?>

							<tr>

								<td><input autocomplete="off" name="vars[<?php echo $i ?>][name]" placeholder="name" type="text"></td>

								<td><span class="equals">=</span></td>

								<td><input autocomplete="off" name="vars[<?php echo $i ?>][val]" placeholder="value" type="text"></td>

								<td></td>

							</tr>

						</tbody>

					</table>

					<p><input type="submit" value="Save" class="button-primary"></p>

				</form>

			</div>

			<div id="custom-global-variables-author-info">

				<img alt="Konnect Digital" class="konnect" src="<?php echo plugin_dir_url( __FILE__ ) ?>/konnect.png"> This is a <a href="https://www.konnectdigital.com.au" target="_blank">Konnect Digital</a> plugin created by <em>Abdullah Khalfan</em>.

			</div>

		</div>

		<?php
	}

	// Shortcode for displaying values
	function shortcode( $params ) {

		if ( ! empty( $GLOBALS['cgv'][ $params[0] ] ) ) {

			return $GLOBALS['cgv'][ $params[0] ];
		}

		return false;
	}	
}

$custom_global_variables = new Custom_Global_Variables;

• This topic was modified 6 years, 10 months ago by ianvanwijk.