Make WordPress Core


Ignore:
Timestamp:
01/29/2020 12:43:23 AM (5 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/canonical/noRewrite.php

    r46586 r47122  
    1010class Tests_Canonical_NoRewrite extends WP_Canonical_UnitTestCase {
    1111
    12     // These test cases are run against the test handler in WP_Canonical
     12    // These test cases are run against the test handler in WP_Canonical.
    1313
    1414    public function setUp() {
     
    3030
    3131    function data() {
    32         /* Format:
    33          * [0]: $test_url,
    34          * [1]: expected results: Any of the following can be used
     32        /*
     33         * Test URL.
     34         * [0]: Test URL.
     35         * [1]: Expected results: Any of the following can be used.
    3536         *      array( 'url': expected redirection location, 'qv': expected query vars to be set via the rewrite AND $_GET );
    3637         *      array( expected query vars to be set, same as 'qv' above )
     
    4142            array( '/?p=123', '/?p=123' ),
    4243
    43             // This post_type arg should be stripped, because p=1 exists, and does not have post_type= in its query string
     44            // This post_type arg should be stripped, because p=1 exists, and does not have post_type= in its query string.
    4445            array( '/?post_type=fake-cpt&p=1', '/?p=1' ),
    4546
    46             // Strip an existing but incorrect post_type arg
     47            // Strip an existing but incorrect post_type arg.
    4748            array( '/?post_type=page&page_id=1', '/?p=1' ),
    4849
    4950            // Trailing spaces and punctuation in query string args.
    50             array(
     51            array( // Space.
    5152                '/?p=358 ',
    5253                array(
     
    5556                ),
    5657                20383,
    57             ), // space
    58             array(
     58            ),
     59            array( // Encoded space.
    5960                '/?p=358%20',
    6061                array(
     
    6364                ),
    6465                20383,
    65             ), // encoded space
    66             array(
     66            ),
     67            array( // Exclamation mark.
    6768                '/?p=358!',
    6869                array(
     
    7172                ),
    7273                20383,
    73             ), // exclamation mark
    74             array(
     74            ),
     75            array( // Encoded exclamation mark.
    7576                '/?p=358%21',
    7677                array(
     
    7980                ),
    8081                20383,
    81             ), // encoded exclamation mark
    82             array(
     82            ),
     83            array( // Double quote.
    8384                '/?p=358"',
    8485                array(
     
    8788                ),
    8889                20383,
    89             ), // double quote
    90             array(
     90            ),
     91            array( // Encoded double quote.
    9192                '/?p=358%22',
    9293                array(
     
    9596                ),
    9697                20383,
    97             ), // encoded double quote
    98             array(
     98            ),
     99            array( // Single quote.
    99100                '/?p=358\'',
    100101                array(
     
    103104                ),
    104105                20383,
    105             ), // single quote
    106             array(
     106            ),
     107            array( // Encoded single quote.
    107108                '/?p=358%27',
    108109                array(
     
    111112                ),
    112113                20383,
    113             ), // encoded single quote
    114             array(
     114            ),
     115            array( // Opening bracket.
    115116                '/?p=358(',
    116117                array(
     
    119120                ),
    120121                20383,
    121             ), // opening bracket
    122             array(
     122            ),
     123            array( // Encoded opening bracket.
    123124                '/?p=358%28',
    124125                array(
     
    127128                ),
    128129                20383,
    129             ), // encoded opening bracket
    130             array(
     130            ),
     131            array( // Closing bracket.
    131132                '/?p=358)',
    132133                array(
     
    135136                ),
    136137                20383,
    137             ), // closing bracket
    138             array(
     138            ),
     139            array( // Encoded closing bracket.
    139140                '/?p=358%29',
    140141                array(
     
    143144                ),
    144145                20383,
    145             ), // encoded closing bracket
    146             array(
     146            ),
     147            array( // Comma.
    147148                '/?p=358,',
    148149                array(
     
    151152                ),
    152153                20383,
    153             ), // comma
    154             array(
     154            ),
     155            array( // Encoded comma.
    155156                '/?p=358%2C',
    156157                array(
     
    159160                ),
    160161                20383,
    161             ), // encoded comma
    162             array(
     162            ),
     163            array( // Period.
    163164                '/?p=358.',
    164165                array(
     
    167168                ),
    168169                20383,
    169             ), // period
    170             array(
     170            ),
     171            array( // Encoded period.
    171172                '/?p=358%2E',
    172173                array(
     
    175176                ),
    176177                20383,
    177             ), // encoded period
    178             array(
     178            ),
     179            array( // Semicolon.
    179180                '/?p=358;',
    180181                array(
     
    183184                ),
    184185                20383,
    185             ), // semicolon
    186             array(
     186            ),
     187            array( // Encoded semicolon.
    187188                '/?p=358%3B',
    188189                array(
     
    191192                ),
    192193                20383,
    193             ), // encoded semicolon
    194             array(
     194            ),
     195            array( // Opening curly bracket.
    195196                '/?p=358{',
    196197                array(
     
    199200                ),
    200201                20383,
    201             ), // opening curly bracket
    202             array(
     202            ),
     203            array( // Encoded opening curly bracket.
    203204                '/?p=358%7B',
    204205                array(
     
    207208                ),
    208209                20383,
    209             ), // encoded opening curly bracket
    210             array(
     210            ),
     211            array( // Closing curly bracket.
    211212                '/?p=358}',
    212213                array(
     
    215216                ),
    216217                20383,
    217             ), // closing curly bracket
    218             array(
     218            ),
     219            array( // Encoded closing curly bracket.
    219220                '/?p=358%7D',
    220221                array(
     
    223224                ),
    224225                20383,
    225             ), // encoded closing curly bracket
    226             array(
     226            ),
     227            array( // Encoded opening curly quote.
    227228                '/?p=358%E2%80%9C',
    228229                array(
     
    231232                ),
    232233                20383,
    233             ), // encoded opening curly quote
    234             array(
     234            ),
     235            array( // Encoded closing curly quote.
    235236                '/?p=358%E2%80%9D',
    236237                array(
     
    239240                ),
    240241                20383,
    241             ), // encoded closing curly quote
     242            ),
    242243
    243244            // Trailing spaces and punctuation in permalinks.
    244             array( '/page/2/ ', '/page/2/', 20383 ), // space
    245             array( '/page/2/%20', '/page/2/', 20383 ), // encoded space
    246             array( '/page/2/!', '/page/2/', 20383 ), // exclamation mark
    247             array( '/page/2/%21', '/page/2/', 20383 ), // encoded exclamation mark
    248             array( '/page/2/"', '/page/2/', 20383 ), // double quote
    249             array( '/page/2/%22', '/page/2/', 20383 ), // encoded double quote
    250             array( '/page/2/\'', '/page/2/', 20383 ), // single quote
    251             array( '/page/2/%27', '/page/2/', 20383 ), // encoded single quote
    252             array( '/page/2/(', '/page/2/', 20383 ), // opening bracket
    253             array( '/page/2/%28', '/page/2/', 20383 ), // encoded opening bracket
    254             array( '/page/2/)', '/page/2/', 20383 ), // closing bracket
    255             array( '/page/2/%29', '/page/2/', 20383 ), // encoded closing bracket
    256             array( '/page/2/,', '/page/2/', 20383 ), // comma
    257             array( '/page/2/%2C', '/page/2/', 20383 ), // encoded comma
    258             array( '/page/2/.', '/page/2/', 20383 ), // period
    259             array( '/page/2/%2E', '/page/2/', 20383 ), // encoded period
    260             array( '/page/2/;', '/page/2/', 20383 ), // semicolon
    261             array( '/page/2/%3B', '/page/2/', 20383 ), // encoded semicolon
    262             array( '/page/2/{', '/page/2/', 20383 ), // opening curly bracket
    263             array( '/page/2/%7B', '/page/2/', 20383 ), // encoded opening curly bracket
    264             array( '/page/2/}', '/page/2/', 20383 ), // closing curly bracket
    265             array( '/page/2/%7D', '/page/2/', 20383 ), // encoded closing curly bracket
    266             array( '/page/2/%E2%80%9C', '/page/2/', 20383 ), // encoded opening curly quote
    267             array( '/page/2/%E2%80%9D', '/page/2/', 20383 ), // encoded closing curly quote
    268 
    269             array( '/?page_id=1', '/?p=1' ), // redirect page_id to p (should cover page_id|p|attachment_id to one another
     245            array( '/page/2/ ', '/page/2/', 20383 ),   // Space.
     246            array( '/page/2/%20', '/page/2/', 20383 ), // Encoded space.
     247            array( '/page/2/!', '/page/2/', 20383 ),   // Exclamation mark.
     248            array( '/page/2/%21', '/page/2/', 20383 ), // Encoded exclamation mark.
     249            array( '/page/2/"', '/page/2/', 20383 ),   // Double quote.
     250            array( '/page/2/%22', '/page/2/', 20383 ), // Encoded double quote.
     251            array( '/page/2/\'', '/page/2/', 20383 ),  // Single quote.
     252            array( '/page/2/%27', '/page/2/', 20383 ), // Encoded single quote.
     253            array( '/page/2/(', '/page/2/', 20383 ),   // Opening bracket.
     254            array( '/page/2/%28', '/page/2/', 20383 ), // Encoded opening bracket.
     255            array( '/page/2/)', '/page/2/', 20383 ),   // Closing bracket.
     256            array( '/page/2/%29', '/page/2/', 20383 ), // Encoded closing bracket.
     257            array( '/page/2/,', '/page/2/', 20383 ),   // Comma.
     258            array( '/page/2/%2C', '/page/2/', 20383 ), // Encoded comma.
     259            array( '/page/2/.', '/page/2/', 20383 ),   // Period.
     260            array( '/page/2/%2E', '/page/2/', 20383 ), // Encoded period.
     261            array( '/page/2/;', '/page/2/', 20383 ),   // Semicolon.
     262            array( '/page/2/%3B', '/page/2/', 20383 ), // Encoded semicolon.
     263            array( '/page/2/{', '/page/2/', 20383 ),   // Opening curly bracket.
     264            array( '/page/2/%7B', '/page/2/', 20383 ), // Encoded opening curly bracket.
     265            array( '/page/2/}', '/page/2/', 20383 ),   // Closing curly bracket.
     266            array( '/page/2/%7D', '/page/2/', 20383 ), // Encoded closing curly bracket.
     267            array( '/page/2/%E2%80%9C', '/page/2/', 20383 ), // Encoded opening curly quote.
     268            array( '/page/2/%E2%80%9D', '/page/2/', 20383 ), // Encoded closing curly quote.
     269
     270            array( '/?page_id=1', '/?p=1' ), // Redirect page_id to p (should cover page_id|p|attachment_id to one another.
    270271            array( '/?page_id=1&post_type=revision', '/?p=1' ),
    271272
Note: See TracChangeset for help on using the changeset viewer.