Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-11-05 02:10:45 +01:00
Code Issues Projects Releases Wiki Activity

Privacy: improve inline documentation.

Browse Source 
Props desrosj.
Fixes #44075.
Built from https://develop.svn.wordpress.org/trunk@43256


git-svn-id: http://core.svn.wordpress.org/trunk@43085 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Andrew Ozz 2018-05-14 14:53:21 +00:00
parent e765930982
commit 3ee58b55b1
3 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
wp-admin/includes/user.php
View File

@ -587,7 +587,7 @@ Please click the following link to activate your user account:
* @access private * @access private
* *
* @param int $request_id Request ID. * @param int $request_id Request ID.
* @return bool|WP_Error * @return bool|WP_Error Returns true/false based on the success of sending the email, or a WP_Error object.
*/ */
function _wp_privacy_resend_request( $request_id ) { function _wp_privacy_resend_request( $request_id ) {
$request_id = absint( $request_id ); $request_id = absint( $request_id );
@ -754,6 +754,7 @@ function _wp_personal_data_handle_actions() {
function _wp_personal_data_cleanup_requests() { function _wp_personal_data_cleanup_requests() {
/** This filter is documented in wp-includes/user.php */ /** This filter is documented in wp-includes/user.php */
$expires = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS ); $expires = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );
$requests_query = new WP_Query( array( $requests_query = new WP_Query( array(
'post_type' => 'user_request', 'post_type' => 'user_request',
'posts_per_page' => -1, 'posts_per_page' => -1,
@ -1011,13 +1012,16 @@ if ( ! class_exists( 'WP_List_Table' ) ) {
/** /**
* WP_Privacy_Requests_Table class. * WP_Privacy_Requests_Table class.
*
* @since 4.9.6
*/ */
abstract class WP_Privacy_Requests_Table extends WP_List_Table { abstract class WP_Privacy_Requests_Table extends WP_List_Table {
/** /**
* Action name for the requests this table will work with. Classes * Action name for the requests this table will work with. Classes
* which inherit from WP_Privacy_Requests_Table should define this. * which inherit from WP_Privacy_Requests_Table should define this.
* e.g. 'export_personal_data' *
* Example: 'export_personal_data'.
* *
* @since 4.9.6 * @since 4.9.6
* *
@ -1039,7 +1043,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array Array of columns. * @return array Array of columns.
*/ */
public function get_columns() { public function get_columns() {
$columns = array( $columns = array(
@ -1057,7 +1061,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @return array * @return array Default sortable columns.
*/ */
protected function get_sortable_columns() { protected function get_sortable_columns() {
return array(); return array();
@ -1068,7 +1072,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @return string * @return string Default primary column name.
*/ */
protected function get_default_primary_column_name() { protected function get_default_primary_column_name() {
return 'email'; return 'email';
@ -1112,12 +1116,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
} }
/** /**
* Get an associative array ( id => link ) with the list * Get an associative array ( id => link ) with the list of views available on this table.
* of views available on this table.
* *
* @since 4.9.6 * @since 4.9.6
* *
* @return array * @return array Associative array of views in the format of $view_name => $view_markup.
*/ */
protected function get_views() { protected function get_views() {
$current_status = isset( $_REQUEST['filter-status'] ) ? sanitize_text_field( $_REQUEST['filter-status'] ) : ''; $current_status = isset( $_REQUEST['filter-status'] ) ? sanitize_text_field( $_REQUEST['filter-status'] ) : '';
@ -1142,7 +1145,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @return array * @return array List of bulk actions.
*/ */
protected function get_bulk_actions() { protected function get_bulk_actions() {
return array( return array(
@ -1256,7 +1259,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string Checkbox column markup.
*/ */
public function column_cb( $item ) { public function column_cb( $item ) {
return sprintf( '<input type="checkbox" name="request_id[]" value="%1$s" /><span class="spinner"></span>', esc_attr( $item->ID ) ); return sprintf( '<input type="checkbox" name="request_id[]" value="%1$s" /><span class="spinner"></span>', esc_attr( $item->ID ) );
@ -1268,7 +1271,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string Status column markup.
*/ */
public function column_status( $item ) { public function column_status( $item ) {
$status = get_post_status( $item->ID ); $status = get_post_status( $item->ID );
@ -1305,7 +1308,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* @since 4.9.6 * @since 4.9.6
* *
* @param int $timestamp Event timestamp. * @param int $timestamp Event timestamp.
* @return string * @return string Human readable date.
*/ */
protected function get_timestamp_as_date( $timestamp ) { protected function get_timestamp_as_date( $timestamp ) {
if ( empty( $timestamp ) ) { if ( empty( $timestamp ) ) {
@ -1329,7 +1332,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @param string $column_name Name of column being shown. * @param string $column_name Name of column being shown.
* @return string * @return string Default column output.
*/ */
public function column_default( $item, $column_name ) { public function column_default( $item, $column_name ) {
$cell_value = $item->$column_name; $cell_value = $item->$column_name;
@ -1342,19 +1345,19 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
} }
/** /**
* Actions column. Overriden by children. * Actions column. Overridden by children.
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string Email column markup.
*/ */
public function column_email( $item ) { public function column_email( $item ) {
return sprintf( '<a href="%1$s">%2$s</a> %3$s', esc_url( 'mailto:' . $item->email ), $item->email, $this->row_actions( array() ) ); return sprintf( '<a href="%1$s">%2$s</a> %3$s', esc_url( 'mailto:' . $item->email ), $item->email, $this->row_actions( array() ) );
} }
/** /**
* Next steps column. Overriden by children. * Next steps column. Overridden by children.
* *
* @since 4.9.6 * @since 4.9.6
* *
@ -1363,11 +1366,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
public function column_next_steps( $item ) {} public function column_next_steps( $item ) {}
/** /**
* Generates content for a single row of the table * Generates content for a single row of the table,
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item The current item * @param WP_User_Request $item The current item.
*/ */
public function single_row( $item ) { public function single_row( $item ) {
$status = $item->status; $status = $item->status;
@ -1378,7 +1381,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
} }
/** /**
* Embed scripts used to perform actions. Overriden by children. * Embed scripts used to perform actions. Overridden by children.
* *
* @since 4.9.6 * @since 4.9.6
*/ */
@ -1415,7 +1418,7 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string Email column markup.
*/ */
public function column_email( $item ) { public function column_email( $item ) {
$exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() ); $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
@ -1444,7 +1447,7 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
} }
/** /**
* Next steps column. * Displays the next steps column.
* *
* @since 4.9.6 * @since 4.9.6
* *
@ -1522,7 +1525,7 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
* @since 4.9.6 * @since 4.9.6
* *
* @param WP_User_Request $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string Email column markup.
*/ */
public function column_email( $item ) { public function column_email( $item ) {
$row_actions = array(); $row_actions = array();

6
wp-includes/user.php
View File

@ -2816,7 +2816,7 @@ function new_user_email_admin_notice() {
* @since 4.9.6 * @since 4.9.6
* @access private * @access private
* *
* @return array * @return array List of core privacy action types.
*/ */
function _wp_privacy_action_request_types() { function _wp_privacy_action_request_types() {
return array( return array(
@ -3281,7 +3281,7 @@ function wp_create_user_request( $email_address = '', $action_name = '', $reques
* @since 4.9.6 * @since 4.9.6
* *
* @param string $action_name Action name of the request. * @param string $action_name Action name of the request.
* @return string * @return string Human readable action name.
*/ */
function wp_user_request_action_description( $action_name ) { function wp_user_request_action_description( $action_name ) {
switch ( $action_name ) { switch ( $action_name ) {
@ -3452,7 +3452,7 @@ function wp_generate_user_request_key( $request_id ) {
} }
/** /**
* Valdate a user request by comparing the key with the request's key. * Validate a user request by comparing the key with the request's key.
* *
* @since 4.9.6 * @since 4.9.6
* *

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.0-alpha-43251'; $wp_version = '5.0-alpha-43256';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.