79 lines
2.0 KiB
PHP
79 lines
2.0 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* WordPress Coding Standard.
|
||
|
|
*
|
||
|
|
* @package WPCS\WordPressCodingStandards
|
||
|
|
* @link https://github.com/WordPress/WordPress-Coding-Standards
|
||
|
|
* @license https://opensource.org/licenses/MIT MIT
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace WordPressCS\WordPress\Sniffs\WP;
|
||
|
|
|
||
|
|
use WordPressCS\WordPress\AbstractArrayAssignmentRestrictionsSniff;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Flag returning high or infinite posts_per_page.
|
||
|
|
*
|
||
|
|
* @link https://vip.wordpress.com/documentation/vip-go/code-review-blockers-warnings-notices/#no-limit-queries
|
||
|
|
*
|
||
|
|
* @package WPCS\WordPressCodingStandards
|
||
|
|
*
|
||
|
|
* @since 0.3.0
|
||
|
|
* @since 0.13.0 Class name changed: this class is now namespaced.
|
||
|
|
* @since 0.14.0 Added the posts_per_page property.
|
||
|
|
* @since 1.0.0 This sniff has been split into two, with the check for high pagination
|
||
|
|
* limit being part of the WP category, and the check for pagination
|
||
|
|
* disabling being part of the VIP category.
|
||
|
|
*/
|
||
|
|
class PostsPerPageSniff extends AbstractArrayAssignmentRestrictionsSniff {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Posts per page property
|
||
|
|
*
|
||
|
|
* Posts per page limit to check against.
|
||
|
|
*
|
||
|
|
* @since 0.14.0
|
||
|
|
*
|
||
|
|
* @var int
|
||
|
|
*/
|
||
|
|
public $posts_per_page = 100;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Groups of variables to restrict.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getGroups() {
|
||
|
|
return array(
|
||
|
|
'posts_per_page' => array(
|
||
|
|
'type' => 'warning',
|
||
|
|
'keys' => array(
|
||
|
|
'posts_per_page',
|
||
|
|
'numberposts',
|
||
|
|
),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Callback to process each confirmed key, to check value.
|
||
|
|
*
|
||
|
|
* @param string $key Array index / key.
|
||
|
|
* @param mixed $val Assigned value.
|
||
|
|
* @param int $line Token line.
|
||
|
|
* @param array $group Group definition.
|
||
|
|
* @return mixed FALSE if no match, TRUE if matches, STRING if matches
|
||
|
|
* with custom error message passed to ->process().
|
||
|
|
*/
|
||
|
|
public function callback( $key, $val, $line, $group ) {
|
||
|
|
$this->posts_per_page = (int) $this->posts_per_page;
|
||
|
|
|
||
|
|
if ( $val > $this->posts_per_page ) {
|
||
|
|
return 'Detected high pagination limit, `%s` is set to `%s`';
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|