WordPress/wp-includes/class-wp-user-request.php
Sergey Biryukov 3ec189f978 Docs: Add missing @since tags for WP_User_Request properties.
Correct type for `$email`, `$confirmed_timestamp`, and `$completed_timestamp` properties.

Props pbiron, garrett-eclipse.
Fixes #49675.
Built from https://develop.svn.wordpress.org/trunk@47494


git-svn-id: http://core.svn.wordpress.org/trunk@47269 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-03-23 20:20:09 +00:00

119 lines
2.1 KiB
PHP

<?php
/**
* WP_User_Request class.
*
* Represents user request data loaded from a WP_Post object.
*
* @since 4.9.6
*/
final class WP_User_Request {
/**
* Request ID.
*
* @since 4.9.6
* @var int
*/
public $ID = 0;
/**
* User ID.
*
* @since 4.9.6
* @var int
*/
public $user_id = 0;
/**
* User email.
*
* @since 4.9.6
* @var string
*/
public $email = '';
/**
* Action name.
*
* @since 4.9.6
* @var string
*/
public $action_name = '';
/**
* Current status.
*
* @since 4.9.6
* @var string
*/
public $status = '';
/**
* Timestamp this request was created.
*
* @since 4.9.6
* @var int|null
*/
public $created_timestamp = null;
/**
* Timestamp this request was last modified.
*
* @since 4.9.6
* @var int|null
*/
public $modified_timestamp = null;
/**
* Timestamp this request was confirmed.
*
* @since 4.9.6
* @var int|null
*/
public $confirmed_timestamp = null;
/**
* Timestamp this request was completed.
*
* @since 4.9.6
* @var int|null
*/
public $completed_timestamp = null;
/**
* Misc data assigned to this request.
*
* @since 4.9.6
* @var array
*/
public $request_data = array();
/**
* Key used to confirm this request.
*
* @since 4.9.6
* @var string
*/
public $confirm_key = '';
/**
* Constructor.
*
* @since 4.9.6
*
* @param WP_Post|object $post Post object.
*/
public function __construct( $post ) {
$this->ID = $post->ID;
$this->user_id = $post->post_author;
$this->email = $post->post_title;
$this->action_name = $post->post_name;
$this->status = $post->post_status;
$this->created_timestamp = strtotime( $post->post_date_gmt );
$this->modified_timestamp = strtotime( $post->post_modified_gmt );
$this->confirmed_timestamp = (int) get_post_meta( $post->ID, '_wp_user_request_confirmed_timestamp', true );
$this->completed_timestamp = (int) get_post_meta( $post->ID, '_wp_user_request_completed_timestamp', true );
$this->request_data = json_decode( $post->post_content, true );
$this->confirm_key = $post->post_password;
}
}