WordPress.org

Make WordPress Core


Ignore:
Timestamp:
08/17/2018 01:50:26 AM (3 years ago)
Author:
pento
Message:

Coding Standards: Upgrade WPCS to 1.0.0

WPCS 1.0.0 includes a bunch of new auto-fixers, which drops the number of coding standards issues across WordPress significantly. Prior to running the auto-fixers, there were 15,312 issues detected. With this commit, we now drop to 4,769 issues.

This change includes three notable additions:

  • Multiline function calls must now put each parameter on a new line.
  • Auto-formatting files is now part of the grunt precommit script.
  • Auto-fixable coding standards issues will now cause Travis failures.

Fixes #44600.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/misc.php

    r43486 r43571  
    166166    // Generate the new file data
    167167    $new_file_data = implode(
    168         "\n", array_merge(
     168        "\n",
     169        array_merge(
    169170            $pre_lines,
    170171            array( $start_marker ),
     
    856857                    'fresh' => '',
    857858                    'light' => '',
    858                 ), $_wp_admin_css_colors
     859                ),
     860                $_wp_admin_css_colors
    859861            )
    860862        );
     
    898900        endforeach;
    899901
    900     ?>
     902        ?>
    901903    </fieldset>
    902904    <?php
     
    11481150        }
    11491151    </script>
    1150 <?php
     1152    <?php
    11511153}
    11521154
     
    14291431        ?>
    14301432        <div class="policy-text-updated notice notice-warning">
    1431             <p><?php
     1433            <p>
     1434            <?php
    14321435                printf(
    14331436                    /* translators: %s: Privacy Policy Guide URL */
     
    14351438                    esc_url( admin_url( 'tools.php?wp-privacy-policy-guide=1' ) )
    14361439                );
    1437             ?></p>
     1440            ?>
     1441            </p>
    14381442        </div>
    14391443        <?php
     
    14541458
    14551459        // Remove updated|removed status.
    1456         $old = (array) get_post_meta( $policy_page_id, '_wp_suggested_privacy_policy_content' );
    1457         $done = array();
     1460        $old          = (array) get_post_meta( $policy_page_id, '_wp_suggested_privacy_policy_content' );
     1461        $done         = array();
    14581462        $update_cache = false;
    14591463
     
    14671471            if ( ! empty( $old_data['updated'] ) ) {
    14681472                // 'updated' is now 'added'.
    1469                 $done[] = array(
     1473                $done[]       = array(
    14701474                    'plugin_name' => $old_data['plugin_name'],
    14711475                    'policy_text' => $old_data['policy_text'],
     
    14981502    public static function get_suggested_policy_text() {
    14991503        $policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' );
    1500         $checked = array();
    1501         $time = time();
    1502         $update_cache = false;
    1503         $new = self::$policy_content;
    1504         $old = array();
     1504        $checked        = array();
     1505        $time           = time();
     1506        $update_cache   = false;
     1507        $new            = self::$policy_content;
     1508        $old            = array();
    15051509
    15061510        if ( $policy_page_id ) {
     
    15171521                    if ( $old_data['plugin_name'] !== $new_data['plugin_name'] ) {
    15181522                        $old_data['plugin_name'] = $new_data['plugin_name'];
    1519                         $update_cache = true;
     1523                        $update_cache            = true;
    15201524                    }
    15211525
     
    15241528                        unset( $old_data['removed'] );
    15251529                        $old_data['added'] = $time;
    1526                         $update_cache = true;
     1530                        $update_cache      = true;
    15271531                    }
    15281532
    15291533                    $checked[] = $old_data;
    1530                     $found = true;
     1534                    $found     = true;
    15311535                } elseif ( $new_data['plugin_name'] === $old_data['plugin_name'] ) {
    15321536                    // The info for the policy was updated.
     
    15361540                        'updated'     => $time,
    15371541                    );
    1538                     $found = $update_cache = true;
     1542                    $found     = $update_cache = true;
    15391543                }
    15401544
     
    16371641        $content_array = self::get_suggested_policy_text();
    16381642
    1639         $content = '';
    1640         $toc = array( '<li><a href="#wp-privacy-policy-guide-introduction">' . __( 'Introduction' ) . '</a></li>' );
    1641         $date_format = __( 'F j, Y' );
    1642         $copy = __( 'Copy' );
     1643        $content       = '';
     1644        $toc           = array( '<li><a href="#wp-privacy-policy-guide-introduction">' . __( 'Introduction' ) . '</a></li>' );
     1645        $date_format   = __( 'F j, Y' );
     1646        $copy          = __( 'Copy' );
    16431647        $return_to_top = '<a href="#" class="return-to-top">' . __( '&uarr; Return to Top' ) . '</a>';
    16441648
     
    16481652            if ( ! empty( $section['removed'] ) ) {
    16491653                $class = ' text-removed';
    1650                 $date = date_i18n( $date_format, $section['removed'] );
     1654                $date  = date_i18n( $date_format, $section['removed'] );
    16511655                $meta  = sprintf( __( 'Removed %s.' ), $date );
    16521656
     
    16551659            } elseif ( ! empty( $section['updated'] ) ) {
    16561660                $class = ' text-updated';
    1657                 $date = date_i18n( $date_format, $section['updated'] );
     1661                $date  = date_i18n( $date_format, $section['updated'] );
    16581662                $meta  = sprintf( __( 'Updated %s.' ), $date );
    16591663            }
     
    16641668
    16651669            $plugin_name = esc_html( $section['plugin_name'] );
    1666             $toc_id = 'wp-privacy-policy-guide-' . sanitize_title( $plugin_name );
    1667             $toc[] = sprintf( '<li><a href="#%1$s">%2$s</a>' . $meta . '</li>', $toc_id, $plugin_name );
     1670            $toc_id      = 'wp-privacy-policy-guide-' . sanitize_title( $plugin_name );
     1671            $toc[]       = sprintf( '<li><a href="#%1$s">%2$s</a>' . $meta . '</li>', $toc_id, $plugin_name );
    16681672
    16691673            $content .= '<div class="privacy-text-section' . $class . '">';
     
    16771681
    16781682            if ( empty( $section['removed'] ) ) {
    1679                 $content .= '<div class="privacy-text-actions">';
    1680                     $content .= '<button type="button" class="privacy-text-copy button">';
     1683                $content         .= '<div class="privacy-text-actions">';
     1684                    $content     .= '<button type="button" class="privacy-text-copy button">';
    16811685                        $content .= $copy;
    16821686                        $content .= '<span class="screen-reader-text">' . sprintf( __( 'Copy suggested policy text from %s.' ), $plugin_name ) . '</span>';
    1683                     $content .= '</button>';
    1684                 $content .= '</div>';
     1687                    $content     .= '</button>';
     1688                $content         .= '</div>';
    16851689            }
    16861690
     
    17281732    public static function get_default_content( $descr = false ) {
    17291733        $suggested_text = $descr ? '<strong class="privacy-policy-tutorial">' . __( 'Suggested text:' ) . ' </strong>' : '';
    1730         $content = '';
     1734        $content        = '';
    17311735
    17321736        // Start of the suggested privacy policy text.
    17331737        $descr && $content .=
    17341738            '<div class="wp-suggested-text">';
    1735         $content .=
     1739        $content           .=
    17361740            '<h2>' . __( 'Who we are' ) . '</h2>';
    17371741        $descr && $content .=
    17381742            '<p class="privacy-policy-tutorial">' . __( 'In this section you should note your site URL, as well as the name of the company, organization, or individual behind it, and some accurate contact information.' ) . '</p>' .
    17391743            '<p class="privacy-policy-tutorial">' . __( 'The amount of information you may be required to show will vary depending on your local or national business regulations. You may, for example, be required to display a physical address, a registered address, or your company registration number.' ) . '</p>';
    1740         $content .=
     1744        $content           .=
    17411745            /* translators: %s Site URL */
    17421746            '<p>' . $suggested_text . sprintf( __( 'Our website address is: %s.' ), get_bloginfo( 'url', 'display' ) ) . '</p>' .
     
    17501754            '<p class="privacy-policy-tutorial">' . __( 'By default WordPress does not collect any personal data about visitors, and only collects the data shown on the User Profile screen from registered users. However some of your plugins may collect personal data. You should add the relevant information below.' ) . '</p>';
    17511755
    1752         $content .=
     1756        $content           .=
    17531757            '<h3>' . __( 'Comments' ) . '</h3>';
    17541758        $descr && $content .=
    17551759            '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should note what information is captured through comments. We have noted the data which WordPress collects by default.' ) . '</p>';
    1756         $content .=
     1760        $content           .=
    17571761            '<p>' . $suggested_text . __( 'When visitors leave comments on the site we collect the data shown in the comments form, and also the visitor&#8217;s IP address and browser user agent string to help spam detection.' ) . '</p>' .
    17581762            '<p>' . __( 'An anonymized string created from your email address (also called a hash) may be provided to the Gravatar service to see if you are using it. The Gravatar service privacy policy is available here: https://automattic.com/privacy/. After approval of your comment, your profile picture is visible to the public in the context of your comment.' ) . '</p>' .
     
    17611765        $descr && $content .=
    17621766            '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should note what information may be disclosed by users who can upload media files. All uploaded files are usually publicly accessible.' ) . '</p>';
    1763         $content .=
     1767        $content           .=
    17641768            '<p>' . $suggested_text . __( 'If you upload images to the website, you should avoid uploading images with embedded location data (EXIF GPS) included. Visitors to the website can download and extract any location data from images on the website.' ) . '</p>' .
    17651769
     
    17681772            '<p class="privacy-policy-tutorial">' . __( 'By default, WordPress does not include a contact form. If you use a contact form plugin, use this subsection to note what personal data is captured when someone submits a contact form, and how long you keep it. For example, you may note that you keep contact form submissions for a certain period for customer service purposes, but you do not use the information submitted through them for marketing purposes.' ) . '</p>';
    17691773
    1770         $content .=
     1774        $content           .=
    17711775            '<h3>' . __( 'Cookies' ) . '</h3>';
    17721776        $descr && $content .=
    17731777            '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list the cookies your web site uses, including those set by your plugins, social media, and analytics. We have provided the cookies which WordPress installs by default.' ) . '</p>';
    1774         $content .=
     1778        $content           .=
    17751779            '<p>' . $suggested_text . __( 'If you leave a comment on our site you may opt-in to saving your name, email address and website in cookies. These are for your convenience so that you do not have to fill in your details again when you leave another comment. These cookies will last for one year.' ) . '</p>' .
    17761780            '<p>' . __( 'If you have an account and you log in to this site, we will set a temporary cookie to determine if your browser accepts cookies. This cookie contains no personal data and is discarded when you close your browser.' ) . '</p>' .
     
    17871791            '<p class="privacy-policy-tutorial">' . __( 'By default WordPress does not collect any analytics data. However, many web hosting accounts collect some anonymous analytics data. You may also have installed a WordPress plugin that provides analytics services. In that case, add information from that plugin here.' ) . '</p>';
    17881792
    1789         $content .=
     1793        $content           .=
    17901794            '<h2>' . __( 'Who we share your data with' ) . '</h2>';
    17911795        $descr && $content .=
     
    17931797            '<p class="privacy-policy-tutorial">' . __( 'By default WordPress does not share any personal data with anyone.' ) . '</p>';
    17941798
    1795         $content .=
     1799        $content           .=
    17961800            '<h2>' . __( 'How long we retain your data' ) . '</h2>';
    17971801        $descr && $content .=
    17981802            '<p class="privacy-policy-tutorial">' . __( 'In this section you should explain how long you retain personal data collected or processed by the web site. While it is your responsibility to come up with the schedule of how long you keep each dataset for and why you keep it, that information does need to be listed here. For example, you may want to say that you keep contact form entries for six months, analytics records for a year, and customer purchase records for ten years.' ) . '</p>';
    1799         $content .=
     1803        $content           .=
    18001804            '<p>' . $suggested_text . __( 'If you leave a comment, the comment and its metadata are retained indefinitely. This is so we can recognize and approve any follow-up comments automatically instead of holding them in a moderation queue.' ) . '</p>' .
    18011805            '<p>' . __( 'For users that register on our website (if any), we also store the personal information they provide in their user profile. All users can see, edit, or delete their personal information at any time (except they cannot change their username). Website administrators can also see and edit that information.' ) . '</p>' .
     
    18041808        $descr && $content .=
    18051809            '<p class="privacy-policy-tutorial">' . __( 'In this section you should explain what rights your users have over their data and how they can invoke those rights.' ) . '</p>';
    1806         $content .=
     1810        $content           .=
    18071811            '<p>' . $suggested_text . __( 'If you have an account on this site, or have left comments, you can request to receive an exported file of the personal data we hold about you, including any data you have provided to us. You can also request that we erase any personal data we hold about you. This does not include any data we are obliged to keep for administrative, legal, or security purposes.' ) . '</p>' .
    18081812
     
    18111815            '<p class="privacy-policy-tutorial">' . __( 'In this section you should list all transfers of your site data outside the European Union and describe the means by which that data is safeguarded to European data protection standards. This could include your web hosting, cloud storage, or other third party services.' ) . '</p>' .
    18121816            '<p class="privacy-policy-tutorial">' . __( 'European data protection law requires data about European residents which is transferred outside the European Union to be safeguarded to the same standards as if the data was in Europe. So in addition to listing where data goes, you should describe how you ensure that these standards are met either by yourself or by your third party providers, whether that is through an agreement such as Privacy Shield, model clauses in your contracts, or binding corporate rules.' ) . '</p>';
    1813         $content .=
     1817        $content           .=
    18141818            '<p>' . $suggested_text . __( 'Visitor comments may be checked through an automated spam detection service.' ) . '</p>' .
    18151819
     
    18181822            '<p class="privacy-policy-tutorial">' . __( 'In this section you should provide a contact method for privacy-specific concerns. If you are required to have a Data Protection Officer, list their name and full contact details here as well.' ) . '</p>';
    18191823
    1820         $content .=
     1824        $content           .=
    18211825            '<h2>' . __( 'Additional information' ) . '</h2>';
    18221826        $descr && $content .=
    18231827            '<p class="privacy-policy-tutorial">' . __( 'If you use your site for commercial purposes and you engage in more complex collection or processing of personal data, you should note the following information in your privacy policy in addition to the information we have already discussed.' ) . '</p>';
    18241828
    1825         $content .=
     1829        $content           .=
    18261830            '<h3>' . __( 'How we protect your data' ) . '</h3>';
    18271831        $descr && $content .=
    18281832            '<p class="privacy-policy-tutorial">' . __( 'In this section you should explain what measures you have taken to protect your users&#8217; data. This could include technical measures such as encryption; security measures such as two factor authentication; and measures such as staff training in data protection. If you have carried out a Privacy Impact Assessment, you can mention it here too.' ) . '</p>';
    18291833
    1830         $content .=
     1834        $content           .=
    18311835            '<h3>' . __( 'What data breach procedures we have in place' ) . '</h3>';
    18321836        $descr && $content .=
    18331837            '<p class="privacy-policy-tutorial">' . __( 'In this section you should explain what procedures you have in place to deal with data breaches, either potential or real, such as internal reporting systems, contact mechanisms, or bug bounties.' ) . '</p>';
    18341838
    1835         $content .=
     1839        $content           .=
    18361840            '<h3>' . __( 'What third parties we receive data from' ) . '</h3>';
    18371841        $descr && $content .=
    18381842            '<p class="privacy-policy-tutorial">' . __( 'If your web site receives data about users from third parties, including advertisers, this information must be included within the section of your privacy policy dealing with third party data.' ) . '</p>';
    18391843
    1840         $content .=
     1844        $content           .=
    18411845            '<h3>' . __( 'What automated decision making and/or profiling we do with user data' ) . '</h3>';
    18421846        $descr && $content .=
    18431847            '<p class="privacy-policy-tutorial">' . __( 'If your web site provides a service which includes automated decision making - for example, allowing customers to apply for credit, or aggregating their data into an advertising profile - you must note that this is taking place, and include information about how that information is used, what decisions are made with that aggregated data, and what rights users have over decisions made without human intervention.' ) . '</p>';
    18441848
    1845         $content .=
     1849        $content           .=
    18461850            '<h3>' . __( 'Industry regulatory disclosure requirements' ) . '</h3>';
    18471851        $descr && $content .=
Note: See TracChangeset for help on using the changeset viewer.