WordPress.org
Get WordPress

Make WordPress Core

Changeset 43257


Ignore:
Timestamp:
05/14/2018 03:11:58 PM (8 years ago)
Author:
azaozz
Message:

Privacy: improve inline documentation.

Props desrosj.
Merges [43256] to the 4.9 branch.
Fixes #44075.

Location:
branches/4.9
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • branches/4.9

  • branches/4.9/src/wp-admin/includes/user.php

    r43231 r43257  
    547547 *
    548548 * @param int $request_id Request ID.
    549  * @return bool|WP_Error
     549 * @return bool|WP_Error Returns true/false based on the success of sending the email, or a WP_Error object.
    550550 */
    551551function _wp_privacy_resend_request( $request_id ) {
    … …  
    714714        /** This filter is documented in wp-includes/user.php */
    715715        $expires        = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );
     716
    716717        $requests_query = new WP_Query( array(
    717718                'post_type'      => 'user_request',
    … …  
    971972/**
    972973 * WP_Privacy_Requests_Table class.
     974 *
     975 * @since 4.9.6
    973976 */
    974977abstract class WP_Privacy_Requests_Table extends WP_List_Table {
    … …  
    977980         * Action name for the requests this table will work with. Classes
    978981         * which inherit from WP_Privacy_Requests_Table should define this.
    979          * e.g. 'export_personal_data'
     982         *
     983         * Example: 'export_personal_data'.
    980984         *
    981985         * @since 4.9.6
    … …  
    9991003         * @since 4.9.6
    10001004         *
    1001          * @param array Array of columns.
     1005         * @return array Array of columns.
    10021006         */
    10031007        public function get_columns() {
    … …  
    10171021         * @since 4.9.6
    10181022         *
    1019          * @return array
     1023         * @return array Default sortable columns.
    10201024         */
    10211025        protected function get_sortable_columns() {
    … …  
    10281032         * @since 4.9.6
    10291033         *
    1030          * @return string
     1034         * @return string Default primary column name.
    10311035         */
    10321036        protected function get_default_primary_column_name() {
    … …  
    10721076
    10731077        /**
    1074          * Get an associative array ( id => link ) with the list
    1075          * of views available on this table.
    1076          *
    1077          * @since 4.9.6
    1078          *
    1079          * @return array
     1078         * Get an associative array ( id => link ) with the list of views available on this table.
     1079         *
     1080         * @since 4.9.6
     1081         *
     1082         * @return array Associative array of views in the format of $view_name => $view_markup.
    10801083         */
    10811084        protected function get_views() {
    … …  
    11021105         * @since 4.9.6
    11031106         *
    1104          * @return array
     1107         * @return array List of bulk actions.
    11051108         */
    11061109        protected function get_bulk_actions() {
    … …  
    12161219         *
    12171220         * @param WP_User_Request $item Item being shown.
    1218          * @return string
     1221         * @return string Checkbox column markup.
    12191222         */
    12201223        public function column_cb( $item ) {
    … …  
    12281231         *
    12291232         * @param WP_User_Request $item Item being shown.
    1230          * @return string
     1233         * @return string Status column markup.
    12311234         */
    12321235        public function column_status( $item ) {
    … …  
    12651268         *
    12661269         * @param int $timestamp Event timestamp.
    1267          * @return string
     1270         * @return string Human readable date.
    12681271         */
    12691272        protected function get_timestamp_as_date( $timestamp ) {
    … …  
    12871290         * @since 4.9.6
    12881291         *
    1289          * @param WP_User_Request $item         Item being shown.
     1292         * @param WP_User_Request $item        Item being shown.
    12901293         * @param string          $column_name Name of column being shown.
    1291          * @return string
     1294         * @return string Default column output.
    12921295         */
    12931296        public function column_default( $item, $column_name ) {
    … …  
    13021305
    13031306        /**
    1304          * Actions column. Overriden by children.
     1307         * Actions column. Overridden by children.
    13051308         *
    13061309         * @since 4.9.6
    13071310         *
    13081311         * @param WP_User_Request $item Item being shown.
    1309          * @return string
     1312         * @return string Email column markup.
    13101313         */
    13111314        public function column_email( $item ) {
    … …  
    13141317
    13151318        /**
    1316          * Next steps column. Overriden by children.
     1319         * Next steps column. Overridden by children.
    13171320         *
    13181321         * @since 4.9.6
    … …  
    13231326
    13241327        /**
    1325          * Generates content for a single row of the table
    1326          *
    1327          * @since 4.9.6
    1328          *
    1329          * @param WP_User_Request $item The current item
     1328         * Generates content for a single row of the table,
     1329         *
     1330         * @since 4.9.6
     1331         *
     1332         * @param WP_User_Request $item The current item.
    13301333         */
    13311334        public function single_row( $item ) {
    … …  
    13381341
    13391342        /**
    1340          * Embed scripts used to perform actions. Overriden by children.
     1343         * Embed scripts used to perform actions. Overridden by children.
    13411344         *
    13421345         * @since 4.9.6
    … …  
    13751378         *
    13761379         * @param WP_User_Request $item Item being shown.
    1377          * @return string
     1380         * @return string Email column markup.
    13781381         */
    13791382        public function column_email( $item ) {
    … …  
    14041407
    14051408        /**
    1406          * Next steps column.
     1409         * Displays the next steps column.
    14071410         *
    14081411         * @since 4.9.6
    … …  
    14551458 * WP_Privacy_Data_Removal_Requests_Table class.
    14561459 *
    1457         * @since 4.9.6
     1460 * @since 4.9.6
    14581461 */
    14591462class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
    … …  
    14821485         *
    14831486         * @param WP_User_Request $item Item being shown.
    1484          * @return string
     1487         * @return string Email column markup.
    14851488         */
    14861489        public function column_email( $item ) {

  • branches/4.9/src/wp-includes/user.php

    r43237 r43257  
    27392739 * @access private
    27402740 *
    2741  * @return array
     2741 * @return array List of core privacy action types.
    27422742 */
    27432743function _wp_privacy_action_request_types() {
    … …  
    32043204 *
    32053205 * @param string $action_name Action name of the request.
    3206  * @return string
     3206 * @return string Human readable action name.
    32073207 */
    32083208function wp_user_request_action_description( $action_name ) {
    … …  
    33303330         *     Data relating to the account action email.
    33313331         *
    3332          *     @type WP_User_Request $request User request object.
     3332         *     @type WP_User_Request $request     User request object.
    33333333         *     @type string          $email       The email address this is being sent to.
    33343334         *     @type string          $description Description of the action being performed so the user knows what the email is for.
    … …  
    33753375
    33763376/**
    3377  * Valdate a user request by comparing the key with the request's key.
     3377 * Validate a user request by comparing the key with the request's key.
    33783378 *
    33793379 * @since 4.9.6
Note: See TracChangeset for help on using the changeset viewer.