Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Abstract for user model

[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

* Core class used to implement the custom WP_User object.

[13] Fix | Delete

[14] Fix | Delete

* @property string $nickname

[15] Fix | Delete

* @property string $description

[16] Fix | Delete

* @property string $user_description

[17] Fix | Delete

* @property string $first_name

[18] Fix | Delete

* @property string $user_firstname

[19] Fix | Delete

* @property string $last_name

[20] Fix | Delete

* @property string $user_lastname

[21] Fix | Delete

* @property string $user_login

[22] Fix | Delete

* @property string $user_pass

[23] Fix | Delete

* @property string $user_nicename

[24] Fix | Delete

* @property string $user_email

[25] Fix | Delete

* @property string $user_url

[26] Fix | Delete

* @property string $user_registered

[27] Fix | Delete

* @property string $user_activation_key

[28] Fix | Delete

* @property string $user_status

[29] Fix | Delete

* @property int $user_level

[30] Fix | Delete

* @property string $display_name

[31] Fix | Delete

* @property string $spam

[32] Fix | Delete

* @property string $deleted

[33] Fix | Delete

* @property string $locale

[34] Fix | Delete

[35] Fix | Delete

abstract class PUM_Abstract_Model_User {

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* The current model version.

[39] Fix | Delete

[40] Fix | Delete

* Used for compatibility testing.

[41] Fix | Delete

* 1 - v1.0.0

[42] Fix | Delete

[43] Fix | Delete

* @var int

[44] Fix | Delete

[45] Fix | Delete

public $model_version = 1;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* The version of the data currently stored for the current item.

[49] Fix | Delete

[50] Fix | Delete

* 1 - v1.0.0

[51] Fix | Delete

[52] Fix | Delete

* @var int

[53] Fix | Delete

[54] Fix | Delete

public $data_version;

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* The user's ID.

[58] Fix | Delete

[59] Fix | Delete

* @var int

[60] Fix | Delete

[61] Fix | Delete

public $ID = 0;

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* @var \WP_User

[65] Fix | Delete

[66] Fix | Delete

public $user;

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* @var array An array of keys that can be accessed via the $this->user (WP_User) object.

[70] Fix | Delete

[71] Fix | Delete

public $core_data_keys = [

[72] Fix | Delete

'nickname',

[73] Fix | Delete

'description',

[74] Fix | Delete

'user_description',

[75] Fix | Delete

'first_name',

[76] Fix | Delete

'user_firstname',

[77] Fix | Delete

'last_name',

[78] Fix | Delete

'user_lastname',

[79] Fix | Delete

'user_login',

[80] Fix | Delete

'user_pass',

[81] Fix | Delete

'user_nicename',

[82] Fix | Delete

'user_email',

[83] Fix | Delete

'user_url',

[84] Fix | Delete

'user_registered',

[85] Fix | Delete

'user_activation_key',

[86] Fix | Delete

'user_status',

[87] Fix | Delete

'user_level',

[88] Fix | Delete

'display_name',

[89] Fix | Delete

'spam',

[90] Fix | Delete

'deleted',

[91] Fix | Delete

'locale',

[92] Fix | Delete

'data',

[93] Fix | Delete

'ID',

[94] Fix | Delete

'caps',

[95] Fix | Delete

'cap_key',

[96] Fix | Delete

'roles',

[97] Fix | Delete

'allcaps',

[98] Fix | Delete

'filter',

[99] Fix | Delete

];

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* The required permission|user_role|capability|user_level of the user.

[103] Fix | Delete

[104] Fix | Delete

protected $required_permission = '';

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Get things going

[108] Fix | Delete

[109] Fix | Delete

* @param WP_User|int $user

[110] Fix | Delete

[111] Fix | Delete

public function __construct( $user ) {

[112] Fix | Delete

if ( ! is_a( $user, 'WP_User' ) ) {

[113] Fix | Delete

$user = new WP_User( $user );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

$this->setup( $user );

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Given the user data, let's set the variables

[121] Fix | Delete

[122] Fix | Delete

* @param WP_User $user The User Object

[123] Fix | Delete

[124] Fix | Delete

protected function setup( $user ) {

[125] Fix | Delete

if ( ! is_a( $user, 'WP_User' ) || ( $this->required_permission && ! $user->has_cap( $this->required_permission ) ) ) {

[126] Fix | Delete

return;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

if ( ! isset( $user->data->ID ) ) {

[130] Fix | Delete

$user->data->ID = 0;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

$this->user = $user;

[134] Fix | Delete

[135] Fix | Delete

// Set $this->ID based on the users ID.

[136] Fix | Delete

$this->ID = $user->ID;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* @param $key

[141] Fix | Delete

[142] Fix | Delete

* @return bool

[143] Fix | Delete

[144] Fix | Delete

public function __isset( $key ) {

[145] Fix | Delete

if ( in_array( $key, $this->core_data_keys ) ) {

[146] Fix | Delete

return isset( $this->user->$key );

[147] Fix | Delete

}

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* @param $key

[152] Fix | Delete

[153] Fix | Delete

public function __unset( $key ) {

[154] Fix | Delete

if ( in_array( $key, $this->core_data_keys ) ) {

[155] Fix | Delete

unset( $this->user->$key );

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Magic __get function to dispatch a call to retrieve a private property

[161] Fix | Delete

[162] Fix | Delete

* @param $key

[163] Fix | Delete

[164] Fix | Delete

* @return mixed|WP_Error

[165] Fix | Delete

[166] Fix | Delete

public function __get( $key ) {

[167] Fix | Delete

if ( in_array( $key, $this->core_data_keys ) ) {

[168] Fix | Delete

[169] Fix | Delete

return $this->user->$key;

[170] Fix | Delete

[171] Fix | Delete

} elseif ( method_exists( $this, 'get_' . $key ) ) {

[172] Fix | Delete

[173] Fix | Delete

return call_user_func( [ $this, 'get_' . $key ] );

[174] Fix | Delete

[175] Fix | Delete

} else {

[176] Fix | Delete

[177] Fix | Delete

$meta = get_user_meta( $this->ID, $key, true );

[178] Fix | Delete

[179] Fix | Delete

if ( $meta ) {

[180] Fix | Delete

return $meta;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

return new WP_Error( 'user-invalid-property', sprintf( __( 'Can\'t get property %s' ), $key ) );

[184] Fix | Delete

[185] Fix | Delete

}

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* @param $name

[190] Fix | Delete

* @param $arguments

[191] Fix | Delete

[192] Fix | Delete

* @return mixed

[193] Fix | Delete

[194] Fix | Delete

public function __call( $name, $arguments ) {

[195] Fix | Delete

if ( method_exists( $this->user, $name ) ) {

[196] Fix | Delete

return call_user_func_array( [ $this->user, $name ], $arguments );

[197] Fix | Delete

}

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

/**

[201] Fix | Delete

* Get per site or global user options.

[202] Fix | Delete

[203] Fix | Delete

* @param $key

[204] Fix | Delete

[205] Fix | Delete

* @return mixed

[206] Fix | Delete

[207] Fix | Delete

public function get_option( $key ) {

[208] Fix | Delete

return get_user_option( $key, $this->ID );

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Used to set per site or global user options.

[213] Fix | Delete

[214] Fix | Delete

* @param $key

[215] Fix | Delete

* @param $value

[216] Fix | Delete

* @param bool $global

[217] Fix | Delete

[218] Fix | Delete

* @return bool|int

[219] Fix | Delete

[220] Fix | Delete

public function update_option( $key, $value, $global = false ) {

[221] Fix | Delete

return update_user_option( $this->ID, $key, $value, $global );

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Used to delete per site or global user options.

[226] Fix | Delete

[227] Fix | Delete

* @param $key

[228] Fix | Delete

* @param bool $global

[229] Fix | Delete

[230] Fix | Delete

* @return bool

[231] Fix | Delete

[232] Fix | Delete

public function delete_option( $key, $global = false ) {

[233] Fix | Delete

return delete_user_option( $this->ID, $key, $global );

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Get user meta.

[238] Fix | Delete

[239] Fix | Delete

* @param $key

[240] Fix | Delete

* @param bool $single

[241] Fix | Delete

[242] Fix | Delete

* @return mixed

[243] Fix | Delete

[244] Fix | Delete

public function get_meta( $key, $single = true ) {

[245] Fix | Delete

return get_user_meta( $this->ID, $key, $single );

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* Add user meta.

[250] Fix | Delete

[251] Fix | Delete

* @param $key

[252] Fix | Delete

* @param $value

[253] Fix | Delete

[254] Fix | Delete

* @return bool|int

[255] Fix | Delete

[256] Fix | Delete

public function add_meta( $key, $value, $unique = false ) {

[257] Fix | Delete

return add_user_meta( $this->ID, $key, $value, $unique );

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Update user meta.

[262] Fix | Delete

[263] Fix | Delete

* @param $key

[264] Fix | Delete

* @param $value

[265] Fix | Delete

[266] Fix | Delete

* @return bool|int

[267] Fix | Delete

[268] Fix | Delete

public function update_meta( $key, $value ) {

[269] Fix | Delete

return update_user_meta( $this->ID, $key, $value );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Delete user meta.

[274] Fix | Delete

[275] Fix | Delete

* @param $key

[276] Fix | Delete

* @param $value

[277] Fix | Delete

[278] Fix | Delete

* @return bool|int

[279] Fix | Delete

[280] Fix | Delete

public function delete_meta( $key, $value = '' ) {

[281] Fix | Delete

return delete_user_meta( $this->ID, $key, $value );

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

/**

[285] Fix | Delete

* @param int $size

[286] Fix | Delete

[287] Fix | Delete

* @return false|string

[288] Fix | Delete

[289] Fix | Delete

public function get_avatar( $size = 35 ) {

[290] Fix | Delete

return get_avatar( $this->ID, $size );

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* Convert object to array.

[295] Fix | Delete

[296] Fix | Delete

* @return array Object as array.

[297] Fix | Delete

[298] Fix | Delete

public function to_array() {

[299] Fix | Delete

$user = $this->user->to_array();

[300] Fix | Delete

[301] Fix | Delete

foreach ( get_object_vars( $this ) as $k => $v ) {

[302] Fix | Delete

$user[ $k ] = $v;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

return $user;

[306] Fix | Delete

}

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete