mirror of
https://github.com/10h30/genesis-simple-sidebars.git
synced 2026-07-13 11:36:22 +09:00
Marcos Schratzenstaller
114 lines
3.3 KiB
PHP
114 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* WordPress Coding Standard.
|
|
*
|
|
* @package WPCS\WordPressCodingStandards
|
|
* @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
|
|
* @license https://opensource.org/licenses/MIT MIT
|
|
*/
|
|
|
|
namespace WordPress\Sniffs\VIP;
|
|
|
|
use WordPress\AbstractVariableRestrictionsSniff;
|
|
|
|
/**
|
|
* Restricts usage of some variables in VIP context.
|
|
*
|
|
* @package WPCS\WordPressCodingStandards
|
|
*
|
|
* @since 0.3.0
|
|
* @since 0.13.0 Class name changed: this class is now namespaced.
|
|
*
|
|
* @deprecated 1.0.0 This sniff has been deprecated.
|
|
* This file remains for now to prevent BC breaks.
|
|
*/
|
|
class RestrictedVariablesSniff extends AbstractVariableRestrictionsSniff {
|
|
|
|
/**
|
|
* Keep track of whether the warnings have been thrown to prevent
|
|
* the messages being thrown for every token triggering the sniff.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @var array
|
|
*/
|
|
private $thrown = array(
|
|
'DeprecatedSniff' => false,
|
|
'FoundPropertyForDeprecatedSniff' => false,
|
|
);
|
|
|
|
/**
|
|
* Groups of variables to restrict.
|
|
*
|
|
* Example: groups => array(
|
|
* 'wpdb' => array(
|
|
* 'type' => 'error' | 'warning',
|
|
* 'message' => 'Dont use this one please!',
|
|
* 'variables' => array( '$val', '$var' ),
|
|
* 'object_vars' => array( '$foo->bar', .. ),
|
|
* 'array_members' => array( '$foo['bar']', .. ),
|
|
* )
|
|
* )
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getGroups() {
|
|
return array(
|
|
// @link https://lobby.vip.wordpress.com/wordpress-com-documentation/code-review-what-we-look-for/#wp_users-and-user_meta
|
|
'user_meta' => array(
|
|
'type' => 'error',
|
|
'message' => 'Usage of users/usermeta tables is highly discouraged in VIP context, For storing user additional user metadata, you should look at User Attributes.',
|
|
'object_vars' => array(
|
|
'$wpdb->users',
|
|
'$wpdb->usermeta',
|
|
),
|
|
),
|
|
|
|
// @link https://lobby.vip.wordpress.com/wordpress-com-documentation/code-review-what-we-look-for/#caching-constraints
|
|
'cache_constraints' => array(
|
|
'type' => 'warning',
|
|
'message' => 'Due to using Batcache, server side based client related logic will not work, use JS instead.',
|
|
'variables' => array(
|
|
'$_COOKIE',
|
|
),
|
|
'array_members' => array(
|
|
'$_SERVER[\'HTTP_USER_AGENT\']',
|
|
'$_SERVER[\'REMOTE_ADDR\']',
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Process the token and handle the deprecation notices.
|
|
*
|
|
* @since 1.0.0 Added to allow for throwing the deprecation notices.
|
|
*
|
|
* @param int $stackPtr The position of the current token in the stack.
|
|
*
|
|
* @return void|int
|
|
*/
|
|
public function process_token( $stackPtr ) {
|
|
if ( false === $this->thrown['DeprecatedSniff'] ) {
|
|
$this->thrown['DeprecatedSniff'] = $this->phpcsFile->addWarning(
|
|
'The "WordPress.VIP.RestrictedVariables" sniff has been deprecated. Please update your custom ruleset.',
|
|
0,
|
|
'DeprecatedSniff'
|
|
);
|
|
}
|
|
|
|
if ( ! empty( $this->exclude )
|
|
&& false === $this->thrown['FoundPropertyForDeprecatedSniff']
|
|
) {
|
|
$this->thrown['FoundPropertyForDeprecatedSniff'] = $this->phpcsFile->addWarning(
|
|
'The "WordPress.VIP.RestrictedVariables" sniff has been deprecated. Please update your custom ruleset.',
|
|
0,
|
|
'FoundPropertyForDeprecatedSniff'
|
|
);
|
|
}
|
|
|
|
return parent::process_token( $stackPtr );
|
|
}
|
|
|
|
}
|