Make WordPress Core


Ignore:
Timestamp:
11/17/2022 06:13:47 PM (2 years ago)
Author:
SergeyBiryukov
Message:

Docs: Update various DocBlocks and inline comments per the documentation standards.

Includes minor formatting edits for consistency.

Follow-up to [53/tests], [12179], [12946], [35288], [37884], [38810], [38928], [46596], [48131], [52955], [53548], [53813], [53873], [54118], [54316], [54420], [54421], [54803].

See #56792.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/functions/wpNonceField.php

    r54420 r54855  
    1515     */
    1616    public function test_wp_nonce_field() {
    17 
    1817        wp_nonce_field();
    1918        $this->expectOutputRegex( '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#' );
     
    2524     * @dataProvider data_wp_nonce_field
    2625     *
    27      * @param int|string $action Action name.
    28      * @param string     $name Nonce name.
    29      * @param bool       $referer Whether to set the referer field fior validation.
    30      * @param string     $expected_reg_exp The expected regular expression.
     26     * @param int|string $action          Action name.
     27     * @param string     $name            Nonce name.
     28     * @param bool       $referer         Whether to set the referer field for validation.
     29     * @param string     $expected_regexp The expected regular expression.
    3130     */
    32     public function test_wp_nonce_field_return( $action, $name, $referer, $expected_reg_exp ) {
    33 
    34         $this->assertMatchesRegularExpression( $expected_reg_exp, wp_nonce_field( $action, $name, $referer, false ) );
     31    public function test_wp_nonce_field_return( $action, $name, $referer, $expected_regexp ) {
     32        $this->assertMatchesRegularExpression( $expected_regexp, wp_nonce_field( $action, $name, $referer, false ) );
    3533    }
    3634
     
    4139     */
    4240    public function data_wp_nonce_field() {
    43 
    4441        return array(
    4542            'default'     => array(
    46                 'action'           => - 1,
    47                 'name'             => '_wpnonce',
    48                 'referer'          => true,
    49                 'expected_reg_exp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
     43                'action'          => -1,
     44                'name'            => '_wpnonce',
     45                'referer'         => true,
     46                'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
    5047            ),
    5148            'nonce_name'  => array(
    52                 'action'           => - 1,
    53                 'name'             => 'nonce_name',
    54                 'referer'          => true,
    55                 'expected_reg_exp' => '#^<input type="hidden" id="nonce_name" name="nonce_name" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
     49                'action'          => -1,
     50                'name'            => 'nonce_name',
     51                'referer'         => true,
     52                'expected_regexp' => '#^<input type="hidden" id="nonce_name" name="nonce_name" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
    5653            ),
    5754            'action_name' => array(
    58                 'action'           => 'action_name',
    59                 'name'             => '_wpnonce',
    60                 'referer'          => true,
    61                 'expected_reg_exp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value="' . wp_create_nonce( 'action_name' ) . '" /><input type="hidden" name="_wp_http_referer" value="" />$#',
     55                'action'          => 'action_name',
     56                'name'            => '_wpnonce',
     57                'referer'         => true,
     58                'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value="' . wp_create_nonce( 'action_name' ) . '" /><input type="hidden" name="_wp_http_referer" value="" />$#',
    6259            ),
    6360            'no_referer'  => array(
    64                 'action'           => - 1,
    65                 'name'             => '_wpnonce',
    66                 'referer'          => false,
    67                 'expected_reg_exp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />$#',
     61                'action'          => -1,
     62                'name'            => '_wpnonce',
     63                'referer'         => false,
     64                'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />$#',
    6865            ),
    6966            '& in name'   => array(
    70                 'action'           => - 1,
    71                 'name'             => 'a&b',
    72                 'referer'          => false,
    73                 'expected_reg_exp' => '#^<input type="hidden" id="a\&amp;b" name="a\&amp;b" value=".{10}" />$#',
     67                'action'          => -1,
     68                'name'            => 'a&b',
     69                'referer'         => false,
     70                'expected_regexp' => '#^<input type="hidden" id="a\&amp;b" name="a\&amp;b" value=".{10}" />$#',
    7471            ),
    7572        );
Note: See TracChangeset for help on using the changeset viewer.