Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Options Utility

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Class PUM_Utils_Options

[13] Fix | Delete

[14] Fix | Delete

class PUM_Utils_Options {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Unique Prefix per plugin.

[18] Fix | Delete

[19] Fix | Delete

* @var string

[20] Fix | Delete

[21] Fix | Delete

public static $_prefix = 'popmake_';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Keeps static copy of the options during runtime.

[25] Fix | Delete

[26] Fix | Delete

* @var null|array

[27] Fix | Delete

[28] Fix | Delete

private static $_data;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Initialize Options on run.

[32] Fix | Delete

[33] Fix | Delete

* @param bool $force

[34] Fix | Delete

[35] Fix | Delete

public static function init( $force = false ) {

[36] Fix | Delete

global $popmake_options;

[37] Fix | Delete

[38] Fix | Delete

if ( ! isset( self::$_data ) || $force ) {

[39] Fix | Delete

self::$_data = self::get_all();

[40] Fix | Delete

[41] Fix | Delete

/** @deprecated 1.7.0 */

[42] Fix | Delete

$popmake_options = self::$_data;

[43] Fix | Delete

}

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Get Settings

[48] Fix | Delete

[49] Fix | Delete

* Retrieves all plugin settings

[50] Fix | Delete

[51] Fix | Delete

* @return array settings

[52] Fix | Delete

[53] Fix | Delete

public static function get_all() {

[54] Fix | Delete

$settings = get_option( self::$_prefix . 'settings', [] );

[55] Fix | Delete

if ( ! is_array( $settings ) ) {

[56] Fix | Delete

$settings = [];

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/* @deprecated filter. */

[60] Fix | Delete

$settings = apply_filters( 'popmake_get_settings', $settings );

[61] Fix | Delete

[62] Fix | Delete

return apply_filters( self::$_prefix . 'get_options', $settings );

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Get an option

[67] Fix | Delete

[68] Fix | Delete

* Looks to see if the specified setting exists, returns default if not

[69] Fix | Delete

[70] Fix | Delete

* @param string $key

[71] Fix | Delete

* @param bool $default

[72] Fix | Delete

[73] Fix | Delete

* @return mixed

[74] Fix | Delete

[75] Fix | Delete

public static function get( $key = '', $default = false ) {

[76] Fix | Delete

// Passive initialization.

[77] Fix | Delete

self::init();

[78] Fix | Delete

[79] Fix | Delete

$value = isset( self::$_data[ $key ] ) ? self::$_data[ $key ] : $default;

[80] Fix | Delete

[81] Fix | Delete

return apply_filters( self::$_prefix . 'get_option', $value, $key, $default );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Update an option

[86] Fix | Delete

[87] Fix | Delete

* Updates an setting value in both the db and the global variable.

[88] Fix | Delete

* Warning: Passing in an empty, false or null string value will remove

[89] Fix | Delete

* the key from the _options array.

[90] Fix | Delete

[91] Fix | Delete

* @param string $key The Key to update

[92] Fix | Delete

* @param string|bool|int $value The value to set the key to

[93] Fix | Delete

[94] Fix | Delete

* @return boolean True if updated, false if not.

[95] Fix | Delete

[96] Fix | Delete

public static function update( $key = '', $value = false ) {

[97] Fix | Delete

// Passive initialization.

[98] Fix | Delete

self::init();

[99] Fix | Delete

[100] Fix | Delete

// If no key, exit

[101] Fix | Delete

if ( empty( $key ) ) {

[102] Fix | Delete

return false;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

if ( empty( $value ) ) {

[106] Fix | Delete

$remove_option = self::delete( $key );

[107] Fix | Delete

[108] Fix | Delete

return $remove_option;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

// First let's grab the current settings

[112] Fix | Delete

$options = get_option( self::$_prefix . 'settings' );

[113] Fix | Delete

[114] Fix | Delete

// Let's let devs alter that value coming in

[115] Fix | Delete

$value = apply_filters( self::$_prefix . 'update_option', $value, $key );

[116] Fix | Delete

[117] Fix | Delete

// Next let's try to update the value

[118] Fix | Delete

$options[ $key ] = $value;

[119] Fix | Delete

$did_update = update_option( self::$_prefix . 'settings', $options );

[120] Fix | Delete

[121] Fix | Delete

// If it updated, let's update the global variable

[122] Fix | Delete

if ( $did_update ) {

[123] Fix | Delete

self::$_data[ $key ] = $value;

[124] Fix | Delete

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

return $did_update;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Update the entire settings array from a new array.

[132] Fix | Delete

[133] Fix | Delete

* @param array $new_options

[134] Fix | Delete

[135] Fix | Delete

* @return bool

[136] Fix | Delete

[137] Fix | Delete

public static function update_all( $new_options = [] ) {

[138] Fix | Delete

// First let's grab the current settings

[139] Fix | Delete

$options = get_option( self::$_prefix . 'settings' );

[140] Fix | Delete

[141] Fix | Delete

// Lets merge options that may exist previously that are not existing now.

[142] Fix | Delete

$new_options = wp_parse_args( $new_options, $options );

[143] Fix | Delete

[144] Fix | Delete

$did_update = update_option( self::$_prefix . 'settings', $new_options );

[145] Fix | Delete

[146] Fix | Delete

// If it updated, let's update the global variable

[147] Fix | Delete

if ( $did_update ) {

[148] Fix | Delete

self::$_data = $new_options;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

return $did_update;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* Merge the new options into the settings array.

[156] Fix | Delete

[157] Fix | Delete

* @param array $new_options

[158] Fix | Delete

[159] Fix | Delete

* @return bool

[160] Fix | Delete

[161] Fix | Delete

public static function merge( $new_options = [] ) {

[162] Fix | Delete

[163] Fix | Delete

$options = self::get_all();

[164] Fix | Delete

[165] Fix | Delete

// Merge new options.

[166] Fix | Delete

foreach ( $new_options as $key => $val ) {

[167] Fix | Delete

$options[ $key ] = ! empty( $val ) ? $val : false;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

$did_update = update_option( self::$_prefix . 'settings', $options );

[171] Fix | Delete

[172] Fix | Delete

// If it updated, let's update the global variable

[173] Fix | Delete

if ( $did_update ) {

[174] Fix | Delete

self::$_data = $options;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

return $did_update;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Remove an option or multiple

[182] Fix | Delete

[183] Fix | Delete

* Removes a setting value in both the db and the global variable.

[184] Fix | Delete

[185] Fix | Delete

* @param string|array $keys The Key/s to delete

[186] Fix | Delete

[187] Fix | Delete

* @return boolean True if updated, false if not.

[188] Fix | Delete

[189] Fix | Delete

public static function delete( $keys = '' ) {

[190] Fix | Delete

// Passive initialization.

[191] Fix | Delete

self::init();

[192] Fix | Delete

[193] Fix | Delete

// If no key, exit

[194] Fix | Delete

if ( empty( $keys ) ) {

[195] Fix | Delete

return false;

[196] Fix | Delete

} elseif ( is_string( $keys ) ) {

[197] Fix | Delete

$keys = [ $keys ];

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

// First let's grab the current settings

[201] Fix | Delete

$options = get_option( self::$_prefix . 'settings' );

[202] Fix | Delete

[203] Fix | Delete

// Remove each key/value pair.

[204] Fix | Delete

foreach ( $keys as $key ) {

[205] Fix | Delete

if ( isset( $options[ $key ] ) ) {

[206] Fix | Delete

unset( $options[ $key ] );

[207] Fix | Delete

}

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$did_update = update_option( self::$_prefix . 'settings', $options );

[211] Fix | Delete

[212] Fix | Delete

// If it updated, let's update the global variable

[213] Fix | Delete

if ( $did_update ) {

[214] Fix | Delete

self::$_data = $options;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

return $did_update;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Remaps option keys.

[222] Fix | Delete

[223] Fix | Delete

* @param array $remap_array an array of $old_key => $new_key values.

[224] Fix | Delete

[225] Fix | Delete

* @return bool

[226] Fix | Delete

[227] Fix | Delete

public static function remap_keys( $remap_array = [] ) {

[228] Fix | Delete

$options = self::get_all();

[229] Fix | Delete

[230] Fix | Delete

foreach ( $remap_array as $key => $new_key ) {

[231] Fix | Delete

$value = self::get( $key, false );

[232] Fix | Delete

if ( ! empty( $value ) ) {

[233] Fix | Delete

$options[ $new_key ] = $value;

[234] Fix | Delete

}

[235] Fix | Delete

unset( $options[ $key ] );

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

$did_update = update_option( self::$_prefix . 'settings', $options );

[239] Fix | Delete

[240] Fix | Delete

// If it updated, let's update the global variable

[241] Fix | Delete

if ( $did_update ) {

[242] Fix | Delete

self::$_data = $options;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

return $did_update;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete