rayelliott
/
_s
Archived
forked from mirror/_s
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1267 from jrfnl/feature/cs-update 

Bring code style up to the latest standards
- This PR addresses code-style issues identified when testing the code against the WordPress Coding Standards.
This commit is contained in:
David A. Kennedy 2018-03-02 18:45:51 -05:00 committed by GitHub
parent 648d11e2b3 f03dfdecd5
commit 72e34ef6bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 301 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/CONTRIBUTING.md vendored
View File

@ -22,6 +22,7 @@ Found a bug you can fix? Fantastic! Patches are always welcome. Here's a few tip
* Include the purpose of your PR. Be explicit about the issue your PR solves. * Include the purpose of your PR. Be explicit about the issue your PR solves.
* Reference any existing issues that relate to your PR. This allows everyone to easily see all related discussions. * Reference any existing issues that relate to your PR. This allows everyone to easily see all related discussions.
* When submitting a change that affects CSS, please make sure that both SCSS sources and output CSS have been updated equally. * When submitting a change that affects CSS, please make sure that both SCSS sources and output CSS have been updated equally.
* `_s` complies with the [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/) and any PR should comply as well.
By contributing code to `_s`, you grant its use under the [GNU General Public License v2 (or later)](LICENSE). By contributing code to `_s`, you grant its use under the [GNU General Public License v2 (or later)](LICENSE).

13
.travis.yml
View File

@ -50,16 +50,17 @@ before_script:
- phpenv config-rm xdebug.ini || echo 'No xdebug config.' - phpenv config-rm xdebug.ini || echo 'No xdebug config.'
# Set up temporary paths. # Set up temporary paths.
- export PHPCS_DIR=/tmp/phpcs - export PHPCS_DIR=/tmp/phpcs
- export SNIFFS_DIR=/tmp/sniffs - export WPCS_DIR=/tmp/wpcs
- export PHPCOMPAT_DIR=/tmp/phpcompatibility
# Install CodeSniffer for WordPress Coding Standards checks. # Install CodeSniffer for WordPress Coding Standards checks.
- if [[ "$SNIFF" == "1" ]]; then git clone -b 2.9.1 --depth 1 https://github.com/squizlabs/PHP_CodeSniffer.git $PHPCS_DIR; fi - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/squizlabs/PHP_CodeSniffer.git $PHPCS_DIR; fi
# Install WordPress Coding Standards. # Install WordPress Coding Standards.
- if [[ "$SNIFF" == "1" ]]; then git clone -b 0.11.0 --depth 1 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git $SNIFFS_DIR; fi - if [[ "$SNIFF" == "1" ]]; then git clone -b 0.14.1 --depth 1 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git $WPCS_DIR; fi
# Install PHP Compatibility sniffs. # Install PHP Compatibility sniffs.
- if [[ "$SNIFF" == "1" ]]; then git clone -b 7.1.5 --depth 1 https://github.com/wimg/PHPCompatibility.git $SNIFFS_DIR/PHPCompatibility; fi - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/wimg/PHPCompatibility.git $PHPCOMPAT_DIR; fi
# Set install path for PHPCS sniffs. # Set install path for PHPCS sniffs.
# @link https://github.com/squizlabs/PHP_CodeSniffer/blob/4237c2fc98cc838730b76ee9cee316f99286a2a7/CodeSniffer.php#L1941 # @link https://github.com/squizlabs/PHP_CodeSniffer/blob/4237c2fc98cc838730b76ee9cee316f99286a2a7/CodeSniffer.php#L1941
- if [[ "$SNIFF" == "1" ]]; then $PHPCS_DIR/scripts/phpcs --config-set installed_paths $SNIFFS_DIR; fi - if [[ "$SNIFF" == "1" ]]; then $PHPCS_DIR/bin/phpcs --config-set installed_paths $WPCS_DIR,$PHPCOMPAT_DIR; fi
# After CodeSniffer install you should refresh your path. # After CodeSniffer install you should refresh your path.
- if [[ "$SNIFF" == "1" ]]; then phpenv rehash; fi - if [[ "$SNIFF" == "1" ]]; then phpenv rehash; fi
# Install JSCS: JavaScript Code Style checker. # Install JSCS: JavaScript Code Style checker.
@ -86,7 +87,7 @@ script:
# @link https://pear.php.net/package/PHP_CodeSniffer/ # @link https://pear.php.net/package/PHP_CodeSniffer/
# Uses a custom ruleset based on WordPress. This ruleset is automatically # Uses a custom ruleset based on WordPress. This ruleset is automatically
# picked up by PHPCS as it's named `phpcs.xml(.dist)`. # picked up by PHPCS as it's named `phpcs.xml(.dist)`.
- if [[ "$SNIFF" == "1" ]]; then $PHPCS_DIR/scripts/phpcs; fi - if [[ "$SNIFF" == "1" ]]; then $PHPCS_DIR/bin/phpcs --runtime-set ignore_warnings_on_exit 1; fi
# Receive notifications for build results. # Receive notifications for build results.
# @link https://docs.travis-ci.com/user/notifications/#Email-notifications # @link https://docs.travis-ci.com/user/notifications/#Email-notifications

20
404.php
View File

@ -7,7 +7,8 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
@ -21,15 +22,15 @@ get_header(); ?>
<p><?php esc_html_e( 'It looks like nothing was found at this location. Maybe try one of the links below or a search?', '_s' ); ?></p> <p><?php esc_html_e( 'It looks like nothing was found at this location. Maybe try one of the links below or a search?', '_s' ); ?></p>
<?php <?php
get_search_form(); get_search_form();
the_widget( 'WP_Widget_Recent_Posts' ); the_widget( 'WP_Widget_Recent_Posts' );
?> ?>
<div class="widget widget_categories"> <div class="widget widget_categories">
<h2 class="widget-title"><?php esc_html_e( 'Most Used Categories', '_s' ); ?></h2> <h2 class="widget-title"><?php esc_html_e( 'Most Used Categories', '_s' ); ?></h2>
<ul> <ul>
<?php <?php
wp_list_categories( array( wp_list_categories( array(
'orderby' => 'count', 'orderby' => 'count',
'order' => 'DESC', 'order' => 'DESC',
@ -37,17 +38,16 @@ get_header(); ?>
'title_li' => '', 'title_li' => '',
'number' => 10, 'number' => 10,
) ); ) );
?> ?>
</ul> </ul>
</div><!-- .widget --> </div><!-- .widget -->
<?php <?php
/* translators: %1$s: smiley */
$_s_archive_content = '<p>' . sprintf( esc_html__( 'Try looking in the monthly archives. %1$s', '_s' ), convert_smilies( ':)' ) ) . '</p>';
the_widget( 'WP_Widget_Archives', 'dropdown=1', "after_title=</h2>$_s_archive_content" );
/* translators: %1$s: smiley */ the_widget( 'WP_Widget_Tag_Cloud' );
$archive_content = '<p>' . sprintf( esc_html__( 'Try looking in the monthly archives. %1$s', '_s' ), convert_smilies( ':)' ) ) . '</p>';
the_widget( 'WP_Widget_Archives', 'dropdown=1', "after_title=</h2>$archive_content" );
the_widget( 'WP_Widget_Tag_Cloud' );
?> ?>
</div><!-- .page-content --> </div><!-- .page-content -->

16
archive.php
View File

@ -7,24 +7,25 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
<?php <?php if ( have_posts() ) : ?>
if ( have_posts() ) : ?>
<header class="page-header"> <header class="page-header">
<?php <?php
the_archive_title( '<h1 class="page-title">', '</h1>' ); the_archive_title( '<h1 class="page-title">', '</h1>' );
the_archive_description( '<div class="archive-description">', '</div>' ); the_archive_description( '<div class="archive-description">', '</div>' );
?> ?>
</header><!-- .page-header --> </header><!-- .page-header -->
<?php <?php
/* Start the Loop */ /* Start the Loop */
while ( have_posts() ) : the_post(); while ( have_posts() ) :
the_post();
/* /*
* Include the Post-Type-specific template for the content. * Include the Post-Type-specific template for the content.
@ -41,7 +42,8 @@ get_header(); ?>
get_template_part( 'template-parts/content', 'none' ); get_template_part( 'template-parts/content', 'none' );
endif; ?> endif;
?>
</main><!-- #main --> </main><!-- #main -->
</div><!-- #primary --> </div><!-- #primary -->

27
comments.php
View File

@ -24,11 +24,12 @@ if ( post_password_required() ) {
<?php <?php
// You can start editing here -- including this comment! // You can start editing here -- including this comment!
if ( have_comments() ) : ?> if ( have_comments() ) :
?>
<h2 class="comments-title"> <h2 class="comments-title">
<?php <?php
$comment_count = get_comments_number(); $_s_comment_count = get_comments_number();
if ( '1' === $comment_count ) { if ( '1' === $_s_comment_count ) {
printf( printf(
/* translators: 1: title. */ /* translators: 1: title. */
esc_html__( 'One thought on &ldquo;%1$s&rdquo;', '_s' ), esc_html__( 'One thought on &ldquo;%1$s&rdquo;', '_s' ),
@ -37,8 +38,8 @@ if ( post_password_required() ) {
} else { } else {
printf( // WPCS: XSS OK. printf( // WPCS: XSS OK.
/* translators: 1: comment count number, 2: title. */ /* translators: 1: comment count number, 2: title. */
esc_html( _nx( '%1$s thought on &ldquo;%2$s&rdquo;', '%1$s thoughts on &ldquo;%2$s&rdquo;', $comment_count, 'comments title', '_s' ) ), esc_html( _nx( '%1$s thought on &ldquo;%2$s&rdquo;', '%1$s thoughts on &ldquo;%2$s&rdquo;', $_s_comment_count, 'comments title', '_s' ) ),
number_format_i18n( $comment_count ), number_format_i18n( $_s_comment_count ),
'<span>' . get_the_title() . '</span>' '<span>' . get_the_title() . '</span>'
); );
} }
@ -49,19 +50,21 @@ if ( post_password_required() ) {
<ol class="comment-list"> <ol class="comment-list">
<?php <?php
wp_list_comments( array( wp_list_comments( array(
'style' => 'ol', 'style' => 'ol',
'short_ping' => true, 'short_ping' => true,
) ); ) );
?> ?>
</ol><!-- .comment-list --> </ol><!-- .comment-list -->
<?php the_comments_navigation(); <?php
the_comments_navigation();
// If comments are closed and there are comments, let's leave a little note, shall we? // If comments are closed and there are comments, let's leave a little note, shall we?
if ( ! comments_open() ) : ?> if ( ! comments_open() ) :
?>
<p class="no-comments"><?php esc_html_e( 'Comments are closed.', '_s' ); ?></p> <p class="no-comments"><?php esc_html_e( 'Comments are closed.', '_s' ); ?></p>
<?php <?php
endif; endif;
endif; // Check for have_comments(). endif; // Check for have_comments().

10
footer.php
View File

@ -15,15 +15,17 @@
<footer id="colophon" class="site-footer"> <footer id="colophon" class="site-footer">
<div class="site-info"> <div class="site-info">
<a href="<?php echo esc_url( __( 'https://wordpress.org/', '_s' ) ); ?>"><?php <a href="<?php echo esc_url( __( 'https://wordpress.org/', '_s' ) ); ?>">
<?php
/* translators: %s: CMS name, i.e. WordPress. */ /* translators: %s: CMS name, i.e. WordPress. */
printf( esc_html__( 'Proudly powered by %s', '_s' ), 'WordPress' ); printf( esc_html__( 'Proudly powered by %s', '_s' ), 'WordPress' );
?></a> ?>
</a>
<span class="sep"> | </span> <span class="sep"> | </span>
<?php <?php
/* translators: 1: Theme name, 2: Theme author. */ /* translators: 1: Theme name, 2: Theme author. */
printf( esc_html__( 'Theme: %1$s by %2$s.', '_s' ), '_s', '<a href="https://automattic.com/">Automattic</a>' ); printf( esc_html__( 'Theme: %1$s by %2$s.', '_s' ), '_s', '<a href="https://automattic.com/">Automattic</a>' );
?> ?>
</div><!-- .site-info --> </div><!-- .site-info -->
</footer><!-- #colophon --> </footer><!-- #colophon -->
</div><!-- #page --> </div><!-- #page -->

3
functions.php
View File

@ -91,6 +91,9 @@ add_action( 'after_setup_theme', '_s_setup' );
* @global int $content_width * @global int $content_width
*/ */
function _s_content_width() { function _s_content_width() {
// This variable is intended to be overruled from themes.
// Open WPCS issue: {@link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/1043}.
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound
$GLOBALS['content_width'] = apply_filters( '_s_content_width', 640 ); $GLOBALS['content_width'] = apply_filters( '_s_content_width', 640 );
} }
add_action( 'after_setup_theme', '_s_content_width', 0 ); add_action( 'after_setup_theme', '_s_content_width', 0 );

28
header.php
View File

@ -28,27 +28,29 @@
<div class="site-branding"> <div class="site-branding">
<?php <?php
the_custom_logo(); the_custom_logo();
if ( is_front_page() && is_home() ) : ?> if ( is_front_page() && is_home() ) :
?>
<h1 class="site-title"><a href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a></h1> <h1 class="site-title"><a href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a></h1>
<?php else : ?> <?php
else :
?>
<p class="site-title"><a href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a></p> <p class="site-title"><a href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a></p>
<?php <?php
endif; endif;
$_s_description = get_bloginfo( 'description', 'display' );
$description = get_bloginfo( 'description', 'display' ); if ( $_s_description || is_customize_preview() ) :
if ( $description || is_customize_preview() ) : ?> ?>
<p class="site-description"><?php echo $description; /* WPCS: xss ok. */ ?></p> <p class="site-description"><?php echo $_s_description; /* WPCS: xss ok. */ ?></p>
<?php <?php endif; ?>
endif; ?>
</div><!-- .site-branding --> </div><!-- .site-branding -->
<nav id="site-navigation" class="main-navigation"> <nav id="site-navigation" class="main-navigation">
<button class="menu-toggle" aria-controls="primary-menu" aria-expanded="false"><?php esc_html_e( 'Primary Menu', '_s' ); ?></button> <button class="menu-toggle" aria-controls="primary-menu" aria-expanded="false"><?php esc_html_e( 'Primary Menu', '_s' ); ?></button>
<?php <?php
wp_nav_menu( array( wp_nav_menu( array(
'theme_location' => 'menu-1', 'theme_location' => 'menu-1',
'menu_id' => 'primary-menu', 'menu_id' => 'primary-menu',
) ); ) );
?> ?>
</nav><!-- #site-navigation --> </nav><!-- #site-navigation -->
</header><!-- #masthead --> </header><!-- #masthead -->

8
inc/custom-header.php
View File

@ -51,16 +51,16 @@ if ( ! function_exists( '_s_header_style' ) ) :
<?php <?php
// Has the text been hidden? // Has the text been hidden?
if ( ! display_header_text() ) : if ( ! display_header_text() ) :
?> ?>
.site-title, .site-title,
.site-description { .site-description {
position: absolute; position: absolute;
clip: rect(1px, 1px, 1px, 1px); clip: rect(1px, 1px, 1px, 1px);
} }
<?php <?php
// If the user has set a custom color for the text use that. // If the user has set a custom color for the text use that.
else : else :
?> ?>
.site-title a, .site-title a,
.site-description { .site-description {
color: #<?php echo esc_attr( $header_text_color ); ?>; color: #<?php echo esc_attr( $header_text_color ); ?>;

45
inc/template-tags.php
View File

@ -112,36 +112,37 @@ if ( ! function_exists( '_s_entry_footer' ) ) :
endif; endif;
if ( ! function_exists( '_s_post_thumbnail' ) ) : if ( ! function_exists( '_s_post_thumbnail' ) ) :
/** /**
* Displays an optional post thumbnail. * Displays an optional post thumbnail.
* *
* Wraps the post thumbnail in an anchor element on index views, or a div * Wraps the post thumbnail in an anchor element on index views, or a div
* element when on single views. * element when on single views.
*/ */
function _s_post_thumbnail() { function _s_post_thumbnail() {
if ( post_password_required() || is_attachment() || ! has_post_thumbnail() ) { if ( post_password_required() || is_attachment() || ! has_post_thumbnail() ) {
return; return;
} }
if ( is_singular() ) : if ( is_singular() ) :
?> ?>
<div class="post-thumbnail"> <div class="post-thumbnail">
<?php the_post_thumbnail(); ?> <?php the_post_thumbnail(); ?>
</div><!-- .post-thumbnail --> </div><!-- .post-thumbnail -->
<?php else : ?> <?php else : ?>
<a class="post-thumbnail" href="<?php the_permalink(); ?>" aria-hidden="true"> <a class="post-thumbnail" href="<?php the_permalink(); ?>" aria-hidden="true">
<?php <?php
the_post_thumbnail( 'post-thumbnail', array( the_post_thumbnail( 'post-thumbnail', array(
'alt' => the_title_attribute( array( 'alt' => the_title_attribute( array(
'echo' => false, 'echo' => false,
) ), ) ),
) ); ) );
?> ?>
</a> </a>
<?php endif; // End is_singular(). <?php
} endif; // End is_singular().
}
endif; endif;

26
inc/woocommerce.php
View File

@ -161,7 +161,7 @@ if ( ! function_exists( '_s_woocommerce_wrapper_before' ) ) {
?> ?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main" role="main"> <main id="main" class="site-main" role="main">
<?php <?php
} }
} }
add_action( 'woocommerce_before_main_content', '_s_woocommerce_wrapper_before' ); add_action( 'woocommerce_before_main_content', '_s_woocommerce_wrapper_before' );
@ -175,7 +175,7 @@ if ( ! function_exists( '_s_woocommerce_wrapper_after' ) ) {
* @return void * @return void
*/ */
function _s_woocommerce_wrapper_after() { function _s_woocommerce_wrapper_after() {
?> ?>
</main><!-- #main --> </main><!-- #main -->
</div><!-- #primary --> </div><!-- #primary -->
<?php <?php
@ -224,10 +224,16 @@ if ( ! function_exists( '_s_woocommerce_cart_link' ) ) {
*/ */
function _s_woocommerce_cart_link() { function _s_woocommerce_cart_link() {
?> ?>
<a class="cart-contents" href="<?php echo esc_url( wc_get_cart_url() ); ?>" title="<?php esc_attr_e( 'View your shopping cart', '_s' ); ?>"> <a class="cart-contents" href="<?php echo esc_url( wc_get_cart_url() ); ?>" title="<?php esc_attr_e( 'View your shopping cart', '_s' ); ?>">
<?php /* translators: number of items in the mini cart. */ ?> <?php
<span class="amount"><?php echo wp_kses_data( WC()->cart->get_cart_subtotal() ); ?></span> <span class="count"><?php echo wp_kses_data( sprintf( _n( '%d item', '%d items', WC()->cart->get_cart_contents_count(), '_s' ), WC()->cart->get_cart_contents_count() ) );?></span> $item_count_text = sprintf(
</a> /* translators: number of items in the mini cart. */
_n( '%d item', '%d items', WC()->cart->get_cart_contents_count(), '_s' ),
WC()->cart->get_cart_contents_count()
);
?>
<span class="amount"><?php echo wp_kses_data( WC()->cart->get_cart_subtotal() ); ?></span> <span class="count"><?php echo esc_html( $item_count_text ); ?></span>
</a>
<?php <?php
} }
} }
@ -251,11 +257,11 @@ if ( ! function_exists( '_s_woocommerce_header_cart' ) ) {
</li> </li>
<li> <li>
<?php <?php
$instance = array( $instance = array(
'title' => '', 'title' => '',
); );
the_widget( 'WC_Widget_Cart', $instance ); the_widget( 'WC_Widget_Cart', $instance );
?> ?>
</li> </li>
</ul> </ul>

2
inc/wpcom.php
View File

@ -17,6 +17,8 @@ function _s_wpcom_setup() {
// Set theme colors for third party services. // Set theme colors for third party services.
if ( ! isset( $themecolors ) ) { if ( ! isset( $themecolors ) ) {
// Whitelist wpcom specific variable intended to be overruled.
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound
$themecolors = array( $themecolors = array(
'bg' => '', 'bg' => '',
'border' => '', 'border' => '',

15
index.php
View File

@ -12,7 +12,8 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
@ -20,16 +21,17 @@ get_header(); ?>
<?php <?php
if ( have_posts() ) : if ( have_posts() ) :
if ( is_home() && ! is_front_page() ) : ?> if ( is_home() && ! is_front_page() ) :
?>
<header> <header>
<h1 class="page-title screen-reader-text"><?php single_post_title(); ?></h1> <h1 class="page-title screen-reader-text"><?php single_post_title(); ?></h1>
</header> </header>
<?php
<?php
endif; endif;
/* Start the Loop */ /* Start the Loop */
while ( have_posts() ) : the_post(); while ( have_posts() ) :
the_post();
/* /*
* Include the Post-Type-specific template for the content. * Include the Post-Type-specific template for the content.
@ -46,7 +48,8 @@ get_header(); ?>
get_template_part( 'template-parts/content', 'none' ); get_template_part( 'template-parts/content', 'none' );
endif; ?> endif;
?>
</main><!-- #main --> </main><!-- #main -->
</div><!-- #primary --> </div><!-- #primary -->

22
page.php
View File

@ -12,23 +12,25 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
<?php <?php
while ( have_posts() ) : the_post(); while ( have_posts() ) :
the_post();
get_template_part( 'template-parts/content', 'page' ); get_template_part( 'template-parts/content', 'page' );
// If comments are open or we have at least one comment, load up the comment template. // If comments are open or we have at least one comment, load up the comment template.
if ( comments_open() || get_comments_number() ) : if ( comments_open() || get_comments_number() ) :
comments_template(); comments_template();
endif; endif;
endwhile; // End of the loop. endwhile; // End of the loop.
?> ?>
</main><!-- #main --> </main><!-- #main -->
</div><!-- #primary --> </div><!-- #primary -->

104
phpcs.xml.dist
View File

@ -8,13 +8,25 @@
<!-- Set a description for this ruleset. --> <!-- Set a description for this ruleset. -->
<description>A custom set of code standard rules to check for WordPress themes.</description> <description>A custom set of code standard rules to check for WordPress themes.</description>
<!--
#############################################################################
COMMAND LINE ARGUMENTS
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
#############################################################################
-->
<!-- Pass some flags to PHPCS: <!-- Pass some flags to PHPCS:
p flag: Show progress of the run. p flag: Show progress of the run.
s flag: Show sniff codes in all reports. s flag: Show sniff codes in all reports.
v flag: Print verbose output.
n flag: Do not print warnings.
--> -->
<arg value="psvn"/> <arg value="ps"/>
<!-- Strip the filepaths down to the relevant bit. -->
<arg name="basepath" value="./"/>
<!-- Check up to 8 files simultanously. -->
<arg name="parallel" value="8"/>
<!-- Only check the PHP, CSS and SCSS files. JS files are checked separately with JSCS and JSHint. --> <!-- Only check the PHP, CSS and SCSS files. JS files are checked separately with JSCS and JSHint. -->
<arg name="extensions" value="php,css,scss/css"/> <arg name="extensions" value="php,css,scss/css"/>
@ -22,18 +34,27 @@
<!-- Check all files in this directory and the directories below it. --> <!-- Check all files in this directory and the directories below it. -->
<file>.</file> <file>.</file>
<!-- Include the WordPress ruleset, with exclusions. -->
<rule ref="WordPress"> <!--
<exclude name="Generic.WhiteSpace.ScopeIndent.IncorrectExact" /> #############################################################################
<exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect" /> USE THE WordPress RULESET
<exclude name="PEAR.Functions.FunctionCallSignature.Indent" /> #############################################################################
</rule> -->
<rule ref="WordPress"/>
<!--
#############################################################################
SNIFF SPECIFIC CONFIGURATION
#############################################################################
-->
<!-- Verify that the text_domain is set to the desired text-domain. <!-- Verify that the text_domain is set to the desired text-domain.
Multiple valid text domains can be provided as a comma-delimited list. --> Multiple valid text domains can be provided as a comma-delimited list. -->
<rule ref="WordPress.WP.I18n"> <rule ref="WordPress.WP.I18n">
<properties> <properties>
<property name="text_domain" type="array" value="_s" /> <property name="text_domain" type="array" value="_s"/>
</properties> </properties>
</rule> </rule>
@ -41,20 +62,71 @@
on the theme hierarchy. --> on the theme hierarchy. -->
<rule ref="WordPress.Files.FileName"> <rule ref="WordPress.Files.FileName">
<properties> <properties>
<property name="is_theme" value="true" /> <property name="is_theme" value="true"/>
</properties> </properties>
</rule> </rule>
<!-- Verify that no WP functions are used which are deprecated or have been removed. <!-- Set the minimum supported WP version. This is used by several sniffs.
The minimum version set here should be in line with the minimum WP version The minimum version set here should be in line with the minimum WP version
as set in the "Requires at least" tag in the readme.txt file. --> as set in the "Requires at least" tag in the readme.txt file. -->
<rule ref="WordPress.WP.DeprecatedFunctions"> <config name="minimum_supported_wp_version" value="4.5"/>
<rule ref="WordPress.Arrays.MultipleStatementAlignment">
<properties> <properties>
<property name="minimum_supported_version" value="4.0" /> <!-- No need to adjust alignment of large arrays when the item with the largest key is removed. -->
<property name="exact" value="false"/>
<!-- Don't align multi-line items if ALL items in the array are multi-line. -->
<property name="alignMultilineItems" value="!=100"/>
<!-- Array assignment operator should always be on the same line as the array key. -->
<property name="ignoreNewlines" value="false"/>
</properties> </properties>
</rule> </rule>
<!-- Include sniffs for PHP cross-version compatibility. --> <!-- Verify that everything in the global namespace is prefixed with a theme specific prefix.
Multiple valid prefixes can be provided as a comma-delimited list. -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array" value="_s" />
</properties>
</rule>
<!--
#############################################################################
USE THE PHPCompatibility RULESET
#############################################################################
-->
<config name="testVersion" value="5.2-99.0"/> <config name="testVersion" value="5.2-99.0"/>
<rule ref="PHPCompatibility"/> <rule ref="PHPCompatibility">
<!-- Whitelist PHP native classes, interfaces, functions and constants which
are back-filled by WP.
Based on:
* /wp-includes/compat.php
* /wp-includes/random_compat/random.php
-->
<exclude name="PHPCompatibility.PHP.NewClasses.errorFound"/>
<exclude name="PHPCompatibility.PHP.NewClasses.typeerrorFound"/>
<exclude name="PHPCompatibility.PHP.NewConstants.json_pretty_printFound"/>
<exclude name="PHPCompatibility.PHP.NewConstants.php_version_idFound"/>
<exclude name="PHPCompatibility.PHP.NewFunctions.hash_equalsFound"/>
<exclude name="PHPCompatibility.PHP.NewFunctions.json_last_error_msgFound"/>
<exclude name="PHPCompatibility.PHP.NewFunctions.random_intFound"/>
<exclude name="PHPCompatibility.PHP.NewFunctions.random_bytesFound"/>
<exclude name="PHPCompatibility.PHP.NewFunctions.array_replace_recursiveFound"/>
<exclude name="PHPCompatibility.PHP.NewInterfaces.jsonserializableFound"/>
</rule>
<!-- Whitelist the WP Core mysql_to_rfc3339() function. -->
<rule ref="PHPCompatibility.PHP.RemovedExtensions">
<properties>
<property name="functionWhitelist" type="array" value="mysql_to_rfc3339"/>
</properties>
</rule>
</ruleset> </ruleset>

18
search.php
View File

@ -7,24 +7,27 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<section id="primary" class="content-area"> <section id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
<?php <?php if ( have_posts() ) : ?>
if ( have_posts() ) : ?>
<header class="page-header"> <header class="page-header">
<h1 class="page-title"><?php <h1 class="page-title">
<?php
/* translators: %s: search query. */ /* translators: %s: search query. */
printf( esc_html__( 'Search Results for: %s', '_s' ), '<span>' . get_search_query() . '</span>' ); printf( esc_html__( 'Search Results for: %s', '_s' ), '<span>' . get_search_query() . '</span>' );
?></h1> ?>
</h1>
</header><!-- .page-header --> </header><!-- .page-header -->
<?php <?php
/* Start the Loop */ /* Start the Loop */
while ( have_posts() ) : the_post(); while ( have_posts() ) :
the_post();
/** /**
* Run the loop for the search to output the results. * Run the loop for the search to output the results.
@ -41,7 +44,8 @@ get_header(); ?>
get_template_part( 'template-parts/content', 'none' ); get_template_part( 'template-parts/content', 'none' );
endif; ?> endif;
?>
</main><!-- #main --> </main><!-- #main -->
</section><!-- #primary --> </section><!-- #primary -->

6
single.php
View File

@ -7,13 +7,15 @@
* @package _s * @package _s
*/ */
get_header(); ?> get_header();
?>
<div id="primary" class="content-area"> <div id="primary" class="content-area">
<main id="main" class="site-main"> <main id="main" class="site-main">
<?php <?php
while ( have_posts() ) : the_post(); while ( have_posts() ) :
the_post();
get_template_part( 'template-parts/content', get_post_type() ); get_template_part( 'template-parts/content', get_post_type() );

41
template-parts/content-none.php
View File

@ -16,35 +16,36 @@
<div class="page-content"> <div class="page-content">
<?php <?php
if ( is_home() && current_user_can( 'publish_posts' ) ) : ?> if ( is_home() && current_user_can( 'publish_posts' ) ) :
<p><?php printf(
printf( '<p>' . wp_kses(
wp_kses( /* translators: 1: link to WP admin new post page. */
/* translators: 1: link to WP admin new post page. */ __( 'Ready to publish your first post? <a href="%1$s">Get started here</a>.', '_s' ),
__( 'Ready to publish your first post? <a href="%1$s">Get started here</a>.', '_s' ), array(
array( 'a' => array(
'a' => array( 'href' => array(),
'href' => array(), ),
), )
) ) . '</p>',
), esc_url( admin_url( 'post-new.php' ) )
esc_url( admin_url( 'post-new.php' ) ) );
);
?></p>
<?php elseif ( is_search() ) : ?> elseif ( is_search() ) :
?>
<p><?php esc_html_e( 'Sorry, but nothing matched your search terms. Please try again with some different keywords.', '_s' ); ?></p> <p><?php esc_html_e( 'Sorry, but nothing matched your search terms. Please try again with some different keywords.', '_s' ); ?></p>
<?php <?php
get_search_form(); get_search_form();
else : ?> else :
?>
<p><?php esc_html_e( 'It seems we can&rsquo;t find what you&rsquo;re looking for. Perhaps searching can help.', '_s' ); ?></p> <p><?php esc_html_e( 'It seems we can&rsquo;t find what you&rsquo;re looking for. Perhaps searching can help.', '_s' ); ?></p>
<?php <?php
get_search_form(); get_search_form();
endif; ?> endif;
?>
</div><!-- .page-content --> </div><!-- .page-content -->
</section><!-- .no-results --> </section><!-- .no-results -->

40
template-parts/content-page.php
View File

@ -18,34 +18,34 @@
<div class="entry-content"> <div class="entry-content">
<?php <?php
the_content(); the_content();
wp_link_pages( array( wp_link_pages( array(
'before' => '<div class="page-links">' . esc_html__( 'Pages:', '_s' ), 'before' => '<div class="page-links">' . esc_html__( 'Pages:', '_s' ),
'after' => '</div>', 'after' => '</div>',
) ); ) );
?> ?>
</div><!-- .entry-content --> </div><!-- .entry-content -->
<?php if ( get_edit_post_link() ) : ?> <?php if ( get_edit_post_link() ) : ?>
<footer class="entry-footer"> <footer class="entry-footer">
<?php <?php
edit_post_link( edit_post_link(
sprintf( sprintf(
wp_kses( wp_kses(
/* translators: %s: Name of current post. Only visible to screen readers */ /* translators: %s: Name of current post. Only visible to screen readers */
__( 'Edit <span class="screen-reader-text">%s</span>', '_s' ), __( 'Edit <span class="screen-reader-text">%s</span>', '_s' ),
array( array(
'span' => array( 'span' => array(
'class' => array(), 'class' => array(),
), ),
) )
),
get_the_title()
), ),
'<span class="edit-link">', get_the_title()
'</span>' ),
); '<span class="edit-link">',
'</span>'
);
?> ?>
</footer><!-- .entry-footer --> </footer><!-- .entry-footer -->
<?php endif; ?> <?php endif; ?>

4
template-parts/content-search.php
View File

@ -16,8 +16,8 @@
<?php if ( 'post' === get_post_type() ) : ?> <?php if ( 'post' === get_post_type() ) : ?>
<div class="entry-meta"> <div class="entry-meta">
<?php <?php
_s_posted_on(); _s_posted_on();
_s_posted_by(); _s_posted_by();
?> ?>
</div><!-- .entry-meta --> </div><!-- .entry-meta -->
<?php endif; ?> <?php endif; ?>

46
template-parts/content.php
View File

@ -18,38 +18,38 @@
the_title( '<h2 class="entry-title"><a href="' . esc_url( get_permalink() ) . '" rel="bookmark">', '</a></h2>' ); the_title( '<h2 class="entry-title"><a href="' . esc_url( get_permalink() ) . '" rel="bookmark">', '</a></h2>' );
endif; endif;
if ( 'post' === get_post_type() ) : ?> if ( 'post' === get_post_type() ) :
<div class="entry-meta"> ?>
<?php <div class="entry-meta">
<?php
_s_posted_on(); _s_posted_on();
_s_posted_by(); _s_posted_by();
?> ?>
</div><!-- .entry-meta --> </div><!-- .entry-meta -->
<?php <?php endif; ?>
endif; ?>
</header><!-- .entry-header --> </header><!-- .entry-header -->
<?php _s_post_thumbnail(); ?> <?php _s_post_thumbnail(); ?>
<div class="entry-content"> <div class="entry-content">
<?php <?php
the_content( sprintf( the_content( sprintf(
wp_kses( wp_kses(
/* translators: %s: Name of current post. Only visible to screen readers */ /* translators: %s: Name of current post. Only visible to screen readers */
__( 'Continue reading<span class="screen-reader-text"> "%s"</span>', '_s' ), __( 'Continue reading<span class="screen-reader-text"> "%s"</span>', '_s' ),
array( array(
'span' => array( 'span' => array(
'class' => array(), 'class' => array(),
), ),
) )
), ),
get_the_title() get_the_title()
) ); ) );
wp_link_pages( array( wp_link_pages( array(
'before' => '<div class="page-links">' . esc_html__( 'Pages:', '_s' ), 'before' => '<div class="page-links">' . esc_html__( 'Pages:', '_s' ),
'after' => '</div>', 'after' => '</div>',
) ); ) );
?> ?>
</div><!-- .entry-content --> </div><!-- .entry-content -->