From cd869790b27a49557def043e2d7a01364e2ff012 Mon Sep 17 00:00:00 2001 From: Steel Wagstaff Date: Tue, 23 Nov 2021 14:43:22 -0800 Subject: [PATCH] chore: update coding standards, improve CI pipeline (#284) * Update depdendencies, add additional PHPUnit configuration file, improve CI pipeline --- .github/workflows/.pipeline.yml | 31 +- comments.php | 2 +- composer.json | 15 +- composer.lock | 588 +++++++++++++++++++++++++------- footer.php | 3 +- functions.php | 4 +- inc/actions/namespace.php | 6 +- inc/activation/namespace.php | 13 +- inc/admin/namespace.php | 54 +-- inc/customizer/namespace.php | 6 +- inc/filters/namespace.php | 7 +- inc/helpers/namespace.php | 36 +- inc/shortcodes/namespace.php | 8 +- partials/book.php | 12 +- partials/contact-form.php | 11 +- partials/content-single.php | 12 +- partials/page-block.php | 12 +- partials/page-header.php | 12 +- partials/paged-navigation.php | 12 + phpcs.ruleset.xml | 6 +- phpunit9.xml | 16 + searchform.php | 8 + 22 files changed, 673 insertions(+), 201 deletions(-) create mode 100644 phpunit9.xml diff --git a/.github/workflows/.pipeline.yml b/.github/workflows/.pipeline.yml index a794847..3d6ab30 100644 --- a/.github/workflows/.pipeline.yml +++ b/.github/workflows/.pipeline.yml @@ -15,13 +15,17 @@ jobs: matrix: php: [ 7.3 ] os: [ ubuntu-18.04 ] - wordpress: [ 5.8.1, latest ] - experimental: [false] + wordpress: [ 5.8.2 ] + experimental: [ false ] include: - php: 7.4 os: ubuntu-20.04 wordpress: latest experimental: true + - php: 7.4 + os: ubuntu-20.04 + wordpress: 'trunk' + experimental: true name: Test - PHP ${{ matrix.php }} - WP ${{ matrix.wordpress }} env: @@ -72,32 +76,39 @@ jobs: run: | export PATH="$HOME/.composer/vendor/bin:$PATH" composer install --no-interaction - composer global require "phpunit/phpunit:7.5.20" - name: Run Lint run: npm run lint if: matrix.experimental == false + - name: Run Frontend Tests + run: npm run test + if: matrix.experimental == false + - name: Run PHP CodeSniffer run: composer standards - name: Install WP tests run: bash bin/install-wp-tests.sh wordpress_test root root localhost ${{ matrix.wordpress }} - - name: Run Coverage + - name: Run PHP Test and PCOV run: composer require pcov/clobber; vendor/bin/pcov clobber; vendor/bin/phpunit --configuration phpunit.xml --coverage-clover coverage.xml if: matrix.experimental == false - - name: Run Frontend Tests - run: npm run test + - name: Upload Coverage to Codecov + run: bash <(curl -s https://codecov.io/bash) if: matrix.experimental == false - name: Run PHP Tests - run: vendor/bin/phpunit + run: composer test + if: matrix.experimental == true && matrix.wordpress != 'trunk' - - name: Upload Coverage to Codecov - run: bash <(curl -s https://codecov.io/bash) - if: matrix.experimental == false + - name: Run PHP Tests with PHPUnit 9 + run: | + composer remove --dev phpunit/phpunit + composer update --dev yoast/phpunit-polyfills --with-dependencies --ignore-platform-reqs + vendor/bin/phpunit --configuration phpunit9.xml + if: matrix.experimental == true && matrix.wordpress == 'trunk' - name: Prepare Build if: startsWith(github.ref, 'refs/tags/') diff --git a/comments.php b/comments.php index 76d80c8..f28f93b 100644 --- a/comments.php +++ b/comments.php @@ -36,7 +36,7 @@ if ( post_password_required() ) { '' . get_the_title() . '' ); } else { - printf( // WPCS: XSS OK. + printf( /* translators: 1: comment count number, 2: title. */ esc_html( _nx( '%1$s thought on “%2$s”', '%1$s thoughts on “%2$s”', $comment_count, 'comments title', 'pressbooks-aldine' ) ), number_format_i18n( $comment_count ), diff --git a/composer.json b/composer.json index 6451bee..a9e93b0 100644 --- a/composer.json +++ b/composer.json @@ -20,19 +20,21 @@ "config": { "platform": { "php": "7.3" - } + }, + "sort-packages": true }, "require": { - "php": ">=7.1", + "php": ">=7.3", "composer/installers": "^1.7", "pressbooks/mix": "^2.1", "soberwp/intervention": "1.2.0-p", "spatie/color": "^1.1" }, "require-dev": { - "phpunit/phpunit": "^7", - "pressbooks/coding-standards": "^1.0", - "wpreadme2markdown/wp2md": "^3.0" + "phpunit/phpunit": "^7.5", + "pressbooks/coding-standards": "^1.1", + "wpreadme2markdown/wp2md": "^3.0", + "yoast/phpunit-polyfills": "^1.0.1" }, "scripts": { "test": [ @@ -44,6 +46,9 @@ "standards": [ "vendor/bin/phpcs --standard=phpcs.ruleset.xml inc partials *.php" ], + "fix": [ + "vendor/bin/phpcbf --standard=phpcs.ruleset.xml inc partials *.php" + ], "localize": [ "wp-pot -o=languages/pressbooks-aldine.pot -d=pressbooks-aldine -t 'Pressbooks (Book Oven Inc.) ' -s '**/*.php'" ], diff --git a/composer.lock b/composer.lock index 7cee526..4860c61 100644 --- a/composer.lock +++ b/composer.lock @@ -4,20 +4,20 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "82a6c1b3ddb7f8bb2af896915dfe3935", + "content-hash": "0268f44ce8e823727ccb95ccb10e756f", "packages": [ { "name": "composer/installers", - "version": "v1.9.0", + "version": "v1.12.0", "source": { "type": "git", "url": "https://github.com/composer/installers.git", - "reference": "b93bcf0fa1fccb0b7d176b0967d969691cd74cca" + "reference": "d20a64ed3c94748397ff5973488761b22f6d3f19" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/installers/zipball/b93bcf0fa1fccb0b7d176b0967d969691cd74cca", - "reference": "b93bcf0fa1fccb0b7d176b0967d969691cd74cca", + "url": "https://api.github.com/repos/composer/installers/zipball/d20a64ed3c94748397ff5973488761b22f6d3f19", + "reference": "d20a64ed3c94748397ff5973488761b22f6d3f19", "shasum": "" }, "require": { @@ -28,17 +28,18 @@ "shama/baton": "*" }, "require-dev": { - "composer/composer": "1.6.* || 2.0.*@dev", - "composer/semver": "1.0.* || 2.0.*@dev", - "phpunit/phpunit": "^4.8.36", - "sebastian/comparator": "^1.2.4", + "composer/composer": "1.6.* || ^2.0", + "composer/semver": "^1 || ^3", + "phpstan/phpstan": "^0.12.55", + "phpstan/phpstan-phpunit": "^0.12.16", + "symfony/phpunit-bridge": "^4.2 || ^5", "symfony/process": "^2.3" }, "type": "composer-plugin", "extra": { "class": "Composer\\Installers\\Plugin", "branch-alias": { - "dev-master": "1.0-dev" + "dev-main": "1.x-dev" } }, "autoload": { @@ -76,6 +77,7 @@ "Porto", "RadPHP", "SMF", + "Starbug", "Thelia", "Whmcs", "WolfCMS", @@ -109,13 +111,16 @@ "majima", "mako", "mediawiki", + "miaoxing", "modulework", "modx", "moodle", "osclass", + "pantheon", "phpbb", "piwik", "ppi", + "processwire", "puppet", "pxcms", "reindex", @@ -125,6 +130,7 @@ "sydes", "sylius", "symfony", + "tastyigniter", "typo3", "wordpress", "yawik", @@ -136,12 +142,16 @@ "url": "https://packagist.com", "type": "custom" }, + { + "url": "https://github.com/composer", + "type": "github" + }, { "url": "https://tidelift.com/funding/github/packagist/composer/composer", "type": "tidelift" } ], - "time": "2020-04-07T06:57:05+00:00" + "time": "2021-09-13T08:19:44+00:00" }, { "name": "pressbooks/mix", @@ -283,6 +293,118 @@ } ], "packages-dev": [ + { + "name": "automattic/vipwpcs", + "version": "2.0.0", + "source": { + "type": "git", + "url": "https://github.com/Automattic/VIP-Coding-Standards.git", + "reference": "fc02f491dc9f51da7c32941ac579f70b9ed300c5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Automattic/VIP-Coding-Standards/zipball/fc02f491dc9f51da7c32941ac579f70b9ed300c5", + "reference": "fc02f491dc9f51da7c32941ac579f70b9ed300c5", + "shasum": "" + }, + "require": { + "php": ">=5.6", + "squizlabs/php_codesniffer": "^3.3.1", + "wp-coding-standards/wpcs": "^2.1" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.5", + "phpcompatibility/php-compatibility": "^9", + "phpunit/phpunit": "^5 || ^6 || ^7" + }, + "suggest": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." + }, + "type": "phpcodesniffer-standard", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Contributors", + "homepage": "https://github.com/Automattic/VIP-Coding-Standards/graphs/contributors" + } + ], + "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress VIP minimum coding conventions", + "keywords": [ + "phpcs", + "standards", + "wordpress" + ], + "time": "2019-07-12T08:47:36+00:00" + }, + { + "name": "dealerdirect/phpcodesniffer-composer-installer", + "version": "v0.7.1", + "source": { + "type": "git", + "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git", + "reference": "fe390591e0241955f22eb9ba327d137e501c771c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/fe390591e0241955f22eb9ba327d137e501c771c", + "reference": "fe390591e0241955f22eb9ba327d137e501c771c", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.0 || ^2.0", + "php": ">=5.3", + "squizlabs/php_codesniffer": "^2.0 || ^3.0 || ^4.0" + }, + "require-dev": { + "composer/composer": "*", + "phpcompatibility/php-compatibility": "^9.0", + "sensiolabs/security-checker": "^4.1.0" + }, + "type": "composer-plugin", + "extra": { + "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin" + }, + "autoload": { + "psr-4": { + "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Franck Nijhof", + "email": "franck.nijhof@dealerdirect.com", + "homepage": "http://www.frenck.nl", + "role": "Developer / IT Manager" + } + ], + "description": "PHP_CodeSniffer Standards Composer Installer Plugin", + "homepage": "http://www.dealerdirect.com", + "keywords": [ + "PHPCodeSniffer", + "PHP_CodeSniffer", + "code quality", + "codesniffer", + "composer", + "installer", + "phpcs", + "plugin", + "qa", + "quality", + "standard", + "standards", + "style guide", + "stylecheck", + "tests" + ], + "time": "2020-12-07T18:04:37+00:00" + }, { "name": "doctrine/instantiator", "version": "1.4.0", @@ -350,16 +472,16 @@ }, { "name": "fig-r/psr2r-sniffer", - "version": "0.5.0", + "version": "0.5.2", "source": { "type": "git", "url": "https://github.com/php-fig-rectified/psr2r-sniffer.git", - "reference": "ff4659fdb1ce8832a9e408a6e22aa05bc93efe10" + "reference": "7eb462bcf19abcae122855a6d79cc8f768c77880" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig-rectified/psr2r-sniffer/zipball/ff4659fdb1ce8832a9e408a6e22aa05bc93efe10", - "reference": "ff4659fdb1ce8832a9e408a6e22aa05bc93efe10", + "url": "https://api.github.com/repos/php-fig-rectified/psr2r-sniffer/zipball/7eb462bcf19abcae122855a6d79cc8f768c77880", + "reference": "7eb462bcf19abcae122855a6d79cc8f768c77880", "shasum": "" }, "require": { @@ -392,37 +514,41 @@ "codesniffer", "cs" ], - "time": "2017-08-30T10:00:39+00:00" + "time": "2019-07-30T11:13:07+00:00" }, { "name": "humanmade/coding-standards", - "version": "v0.5.0", + "version": "v1.1.3", "source": { "type": "git", "url": "https://github.com/humanmade/coding-standards.git", - "reference": "b35747249bcc727a9eff22f746aaf9758d8a90ce" + "reference": "6efe4b8fd33c22f06febc658c805acdc1e4d94f5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/humanmade/coding-standards/zipball/b35747249bcc727a9eff22f746aaf9758d8a90ce", - "reference": "b35747249bcc727a9eff22f746aaf9758d8a90ce", + "url": "https://api.github.com/repos/humanmade/coding-standards/zipball/6efe4b8fd33c22f06febc658c805acdc1e4d94f5", + "reference": "6efe4b8fd33c22f06febc658c805acdc1e4d94f5", "shasum": "" }, "require": { + "automattic/vipwpcs": "2.0.0", + "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0", "fig-r/psr2r-sniffer": "^0.5.0", - "squizlabs/php_codesniffer": "^3.1", - "wp-coding-standards/wpcs": "^0.14.0" + "php": ">=7.1", + "phpcompatibility/phpcompatibility-wp": "^2.0.0", + "squizlabs/php_codesniffer": "~3.5.0", + "wp-coding-standards/wpcs": "2.2.1" }, "require-dev": { "phpunit/phpunit": "^5.7" }, - "type": "project", + "type": "phpcodesniffer-standard", "notification-url": "https://packagist.org/downloads/", "license": [ "GPL-2.0-or-later" ], - "description": "Human Made coding standards", - "time": "2018-05-22T13:24:47+00:00" + "description": "Human Made Coding Standards", + "time": "2021-02-03T22:20:56+00:00" }, { "name": "myclabs/deep-copy", @@ -580,6 +706,166 @@ "description": "Library for handling version information and constraints", "time": "2018-07-08T19:19:57+00:00" }, + { + "name": "phpcompatibility/php-compatibility", + "version": "9.3.5", + "source": { + "type": "git", + "url": "https://github.com/PHPCompatibility/PHPCompatibility.git", + "reference": "9fb324479acf6f39452e0655d2429cc0d3914243" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/PHPCompatibility/PHPCompatibility/zipball/9fb324479acf6f39452e0655d2429cc0d3914243", + "reference": "9fb324479acf6f39452e0655d2429cc0d3914243", + "shasum": "" + }, + "require": { + "php": ">=5.3", + "squizlabs/php_codesniffer": "^2.3 || ^3.0.2" + }, + "conflict": { + "squizlabs/php_codesniffer": "2.6.2" + }, + "require-dev": { + "phpunit/phpunit": "~4.5 || ^5.0 || ^6.0 || ^7.0" + }, + "suggest": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.", + "roave/security-advisories": "dev-master || Helps prevent installing dependencies with known security issues." + }, + "type": "phpcodesniffer-standard", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-3.0-or-later" + ], + "authors": [ + { + "name": "Wim Godden", + "homepage": "https://github.com/wimg", + "role": "lead" + }, + { + "name": "Juliette Reinders Folmer", + "homepage": "https://github.com/jrfnl", + "role": "lead" + }, + { + "name": "Contributors", + "homepage": "https://github.com/PHPCompatibility/PHPCompatibility/graphs/contributors" + } + ], + "description": "A set of sniffs for PHP_CodeSniffer that checks for PHP cross-version compatibility.", + "homepage": "http://techblog.wimgodden.be/tag/codesniffer/", + "keywords": [ + "compatibility", + "phpcs", + "standards" + ], + "time": "2019-12-27T09:44:58+00:00" + }, + { + "name": "phpcompatibility/phpcompatibility-paragonie", + "version": "1.3.1", + "source": { + "type": "git", + "url": "https://github.com/PHPCompatibility/PHPCompatibilityParagonie.git", + "reference": "ddabec839cc003651f2ce695c938686d1086cf43" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/PHPCompatibility/PHPCompatibilityParagonie/zipball/ddabec839cc003651f2ce695c938686d1086cf43", + "reference": "ddabec839cc003651f2ce695c938686d1086cf43", + "shasum": "" + }, + "require": { + "phpcompatibility/php-compatibility": "^9.0" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.7", + "paragonie/random_compat": "dev-master", + "paragonie/sodium_compat": "dev-master" + }, + "suggest": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.7 || This Composer plugin will sort out the PHP_CodeSniffer 'installed_paths' automatically.", + "roave/security-advisories": "dev-master || Helps prevent installing dependencies with known security issues." + }, + "type": "phpcodesniffer-standard", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-3.0-or-later" + ], + "authors": [ + { + "name": "Wim Godden", + "role": "lead" + }, + { + "name": "Juliette Reinders Folmer", + "role": "lead" + } + ], + "description": "A set of rulesets for PHP_CodeSniffer to check for PHP cross-version compatibility issues in projects, while accounting for polyfills provided by the Paragonie polyfill libraries.", + "homepage": "http://phpcompatibility.com/", + "keywords": [ + "compatibility", + "paragonie", + "phpcs", + "polyfill", + "standards" + ], + "time": "2021-02-15T10:24:51+00:00" + }, + { + "name": "phpcompatibility/phpcompatibility-wp", + "version": "2.1.2", + "source": { + "type": "git", + "url": "https://github.com/PHPCompatibility/PHPCompatibilityWP.git", + "reference": "a792ab623069f0ce971b2417edef8d9632e32f75" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/PHPCompatibility/PHPCompatibilityWP/zipball/a792ab623069f0ce971b2417edef8d9632e32f75", + "reference": "a792ab623069f0ce971b2417edef8d9632e32f75", + "shasum": "" + }, + "require": { + "phpcompatibility/php-compatibility": "^9.0", + "phpcompatibility/phpcompatibility-paragonie": "^1.0" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.7" + }, + "suggest": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.7 || This Composer plugin will sort out the PHP_CodeSniffer 'installed_paths' automatically.", + "roave/security-advisories": "dev-master || Helps prevent installing dependencies with known security issues." + }, + "type": "phpcodesniffer-standard", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-3.0-or-later" + ], + "authors": [ + { + "name": "Wim Godden", + "role": "lead" + }, + { + "name": "Juliette Reinders Folmer", + "role": "lead" + } + ], + "description": "A ruleset for PHP_CodeSniffer to check for PHP cross-version compatibility issues in projects, while accounting for polyfills provided by WordPress.", + "homepage": "http://phpcompatibility.com/", + "keywords": [ + "compatibility", + "phpcs", + "standards", + "wordpress" + ], + "time": "2021-07-21T11:09:57+00:00" + }, { "name": "phpdocumentor/reflection-common", "version": "2.2.0", @@ -631,16 +917,16 @@ }, { "name": "phpdocumentor/reflection-docblock", - "version": "5.2.2", + "version": "5.3.0", "source": { "type": "git", "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "069a785b2141f5bcf49f3e353548dc1cce6df556" + "reference": "622548b623e81ca6d78b721c5e029f4ce664f170" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/069a785b2141f5bcf49f3e353548dc1cce6df556", - "reference": "069a785b2141f5bcf49f3e353548dc1cce6df556", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/622548b623e81ca6d78b721c5e029f4ce664f170", + "reference": "622548b623e81ca6d78b721c5e029f4ce664f170", "shasum": "" }, "require": { @@ -651,7 +937,8 @@ "webmozart/assert": "^1.9.1" }, "require-dev": { - "mockery/mockery": "~1.3.2" + "mockery/mockery": "~1.3.2", + "psalm/phar": "^4.8" }, "type": "library", "extra": { @@ -679,20 +966,20 @@ } ], "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", - "time": "2020-09-03T19:13:55+00:00" + "time": "2021-10-19T17:43:47+00:00" }, { "name": "phpdocumentor/type-resolver", - "version": "1.4.0", + "version": "1.5.1", "source": { "type": "git", "url": "https://github.com/phpDocumentor/TypeResolver.git", - "reference": "6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0" + "reference": "a12f7e301eb7258bb68acd89d4aefa05c2906cae" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0", - "reference": "6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0", + "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/a12f7e301eb7258bb68acd89d4aefa05c2906cae", + "reference": "a12f7e301eb7258bb68acd89d4aefa05c2906cae", "shasum": "" }, "require": { @@ -700,7 +987,8 @@ "phpdocumentor/reflection-common": "^2.0" }, "require-dev": { - "ext-tokenizer": "*" + "ext-tokenizer": "*", + "psalm/phar": "^4.8" }, "type": "library", "extra": { @@ -724,37 +1012,37 @@ } ], "description": "A PSR-5 based resolver of Class names, Types and Structural Element Names", - "time": "2020-09-17T18:55:26+00:00" + "time": "2021-10-02T14:08:47+00:00" }, { "name": "phpspec/prophecy", - "version": "1.13.0", + "version": "1.14.0", "source": { "type": "git", "url": "https://github.com/phpspec/prophecy.git", - "reference": "be1996ed8adc35c3fd795488a653f4b518be70ea" + "reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/be1996ed8adc35c3fd795488a653f4b518be70ea", - "reference": "be1996ed8adc35c3fd795488a653f4b518be70ea", + "url": "https://api.github.com/repos/phpspec/prophecy/zipball/d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e", + "reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e", "shasum": "" }, "require": { "doctrine/instantiator": "^1.2", - "php": "^7.2 || ~8.0, <8.1", + "php": "^7.2 || ~8.0, <8.2", "phpdocumentor/reflection-docblock": "^5.2", "sebastian/comparator": "^3.0 || ^4.0", "sebastian/recursion-context": "^3.0 || ^4.0" }, "require-dev": { - "phpspec/phpspec": "^6.0", + "phpspec/phpspec": "^6.0 || ^7.0", "phpunit/phpunit": "^8.0 || ^9.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.11.x-dev" + "dev-master": "1.x-dev" } }, "autoload": { @@ -787,7 +1075,7 @@ "spy", "stub" ], - "time": "2021-03-17T13:42:18+00:00" + "time": "2021-09-10T09:02:12+00:00" }, { "name": "phpunit/php-code-coverage", @@ -854,16 +1142,16 @@ }, { "name": "phpunit/php-file-iterator", - "version": "2.0.3", + "version": "2.0.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "4b49fb70f067272b659ef0174ff9ca40fdaa6357" + "reference": "28af674ff175d0768a5a978e6de83f697d4a7f05" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/4b49fb70f067272b659ef0174ff9ca40fdaa6357", - "reference": "4b49fb70f067272b659ef0174ff9ca40fdaa6357", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/28af674ff175d0768a5a978e6de83f697d4a7f05", + "reference": "28af674ff175d0768a5a978e6de83f697d4a7f05", "shasum": "" }, "require": { @@ -906,7 +1194,7 @@ "type": "github" } ], - "time": "2020-11-30T08:25:21+00:00" + "time": "2021-07-19T06:46:01+00:00" }, { "name": "phpunit/php-text-template", @@ -1006,16 +1294,16 @@ }, { "name": "phpunit/php-token-stream", - "version": "3.1.2", + "version": "3.1.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-token-stream.git", - "reference": "472b687829041c24b25f475e14c2f38a09edf1c2" + "reference": "9c1da83261628cb24b6a6df371b6e312b3954768" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/472b687829041c24b25f475e14c2f38a09edf1c2", - "reference": "472b687829041c24b25f475e14c2f38a09edf1c2", + "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/9c1da83261628cb24b6a6df371b6e312b3954768", + "reference": "9c1da83261628cb24b6a6df371b6e312b3954768", "shasum": "" }, "require": { @@ -1058,7 +1346,7 @@ } ], "abandoned": true, - "time": "2020-11-30T08:38:46+00:00" + "time": "2021-07-26T12:15:06+00:00" }, { "name": "phpunit/phpunit", @@ -1146,32 +1434,31 @@ }, { "name": "pressbooks/coding-standards", - "version": "1.0.0", + "version": "1.1.0", "source": { "type": "git", "url": "https://github.com/pressbooks/coding-standards.git", - "reference": "2c41415fd7eb121d871364bf1e460f724024758c" + "reference": "e332af77b246b088c5320934296746c1033a98cb" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/pressbooks/coding-standards/zipball/2c41415fd7eb121d871364bf1e460f724024758c", - "reference": "2c41415fd7eb121d871364bf1e460f724024758c", + "url": "https://api.github.com/repos/pressbooks/coding-standards/zipball/e332af77b246b088c5320934296746c1033a98cb", + "reference": "e332af77b246b088c5320934296746c1033a98cb", "shasum": "" }, "require": { - "fig-r/psr2r-sniffer": "0.5.0", - "humanmade/coding-standards": "0.5.0", - "squizlabs/php_codesniffer": "3.3.2" + "humanmade/coding-standards": "^1.0", + "squizlabs/php_codesniffer": "^3.5" }, "require-dev": { - "phpunit/phpunit": "6.5.13" + "phpunit/phpunit": "^7.0" }, "type": "project", "notification-url": "https://packagist.org/downloads/", "license": [ "GPL-3.0-or-later" ], - "time": "2018-12-14T16:09:42+00:00" + "time": "2021-08-09T16:26:32+00:00" }, { "name": "psr/container", @@ -1461,16 +1748,16 @@ }, { "name": "sebastian/exporter", - "version": "3.1.3", + "version": "3.1.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "6b853149eab67d4da22291d36f5b0631c0fd856e" + "reference": "0c32ea2e40dbf59de29f3b49bf375176ce7dd8db" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/6b853149eab67d4da22291d36f5b0631c0fd856e", - "reference": "6b853149eab67d4da22291d36f5b0631c0fd856e", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/0c32ea2e40dbf59de29f3b49bf375176ce7dd8db", + "reference": "0c32ea2e40dbf59de29f3b49bf375176ce7dd8db", "shasum": "" }, "require": { @@ -1479,7 +1766,7 @@ }, "require-dev": { "ext-mbstring": "*", - "phpunit/phpunit": "^6.0" + "phpunit/phpunit": "^8.5" }, "type": "library", "extra": { @@ -1530,7 +1817,7 @@ "type": "github" } ], - "time": "2020-11-30T07:47:53+00:00" + "time": "2021-11-11T13:51:24+00:00" }, { "name": "sebastian/global-state", @@ -1839,16 +2126,16 @@ }, { "name": "squizlabs/php_codesniffer", - "version": "3.3.2", + "version": "3.5.8", "source": { "type": "git", "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", - "reference": "6ad28354c04b364c3c71a34e4a18b629cc3b231e" + "reference": "9d583721a7157ee997f235f327de038e7ea6dac4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/6ad28354c04b364c3c71a34e4a18b629cc3b231e", - "reference": "6ad28354c04b364c3c71a34e4a18b629cc3b231e", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/9d583721a7157ee997f235f327de038e7ea6dac4", + "reference": "9d583721a7157ee997f235f327de038e7ea6dac4", "shasum": "" }, "require": { @@ -1881,25 +2168,25 @@ } ], "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", - "homepage": "http://www.squizlabs.com/php-codesniffer", + "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", "keywords": [ "phpcs", "standards" ], - "time": "2018-09-23T23:08:17+00:00" + "time": "2020-10-23T02:01:07+00:00" }, { "name": "symfony/console", - "version": "v5.3.2", + "version": "v5.3.10", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "649730483885ff2ca99ca0560ef0e5f6b03f2ac1" + "reference": "d4e409d9fbcfbf71af0e5a940abb7b0b4bad0bd3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/649730483885ff2ca99ca0560ef0e5f6b03f2ac1", - "reference": "649730483885ff2ca99ca0560ef0e5f6b03f2ac1", + "url": "https://api.github.com/repos/symfony/console/zipball/d4e409d9fbcfbf71af0e5a940abb7b0b4bad0bd3", + "reference": "d4e409d9fbcfbf71af0e5a940abb7b0b4bad0bd3", "shasum": "" }, "require": { @@ -1907,11 +2194,12 @@ "symfony/deprecation-contracts": "^2.1", "symfony/polyfill-mbstring": "~1.0", "symfony/polyfill-php73": "^1.8", - "symfony/polyfill-php80": "^1.15", + "symfony/polyfill-php80": "^1.16", "symfony/service-contracts": "^1.1|^2", "symfony/string": "^5.1" }, "conflict": { + "psr/log": ">=3", "symfony/dependency-injection": "<4.4", "symfony/dotenv": "<5.1", "symfony/event-dispatcher": "<4.4", @@ -1919,10 +2207,10 @@ "symfony/process": "<4.4" }, "provide": { - "psr/log-implementation": "1.0" + "psr/log-implementation": "1.0|2.0" }, "require-dev": { - "psr/log": "~1.0", + "psr/log": "^1|^2", "symfony/config": "^4.4|^5.0", "symfony/dependency-injection": "^4.4|^5.0", "symfony/event-dispatcher": "^4.4|^5.0", @@ -1981,7 +2269,7 @@ "type": "tidelift" } ], - "time": "2021-06-12T09:42:48+00:00" + "time": "2021-10-26T09:30:15+00:00" }, { "name": "symfony/deprecation-contracts", @@ -2125,16 +2413,16 @@ }, { "name": "symfony/polyfill-intl-grapheme", - "version": "v1.23.0", + "version": "v1.23.1", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-intl-grapheme.git", - "reference": "24b72c6baa32c746a4d0840147c9715e42bb68ab" + "reference": "16880ba9c5ebe3642d1995ab866db29270b36535" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/24b72c6baa32c746a4d0840147c9715e42bb68ab", - "reference": "24b72c6baa32c746a4d0840147c9715e42bb68ab", + "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/16880ba9c5ebe3642d1995ab866db29270b36535", + "reference": "16880ba9c5ebe3642d1995ab866db29270b36535", "shasum": "" }, "require": { @@ -2199,7 +2487,7 @@ "type": "tidelift" } ], - "time": "2021-05-27T09:17:38+00:00" + "time": "2021-05-27T12:26:48+00:00" }, { "name": "symfony/polyfill-intl-normalizer", @@ -2284,16 +2572,16 @@ }, { "name": "symfony/polyfill-mbstring", - "version": "v1.23.0", + "version": "v1.23.1", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "2df51500adbaebdc4c38dea4c89a2e131c45c8a1" + "reference": "9174a3d80210dca8daa7f31fec659150bbeabfc6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/2df51500adbaebdc4c38dea4c89a2e131c45c8a1", - "reference": "2df51500adbaebdc4c38dea4c89a2e131c45c8a1", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/9174a3d80210dca8daa7f31fec659150bbeabfc6", + "reference": "9174a3d80210dca8daa7f31fec659150bbeabfc6", "shasum": "" }, "require": { @@ -2357,7 +2645,7 @@ "type": "tidelift" } ], - "time": "2021-05-27T09:27:20+00:00" + "time": "2021-05-27T12:26:48+00:00" }, { "name": "symfony/polyfill-php73", @@ -2437,16 +2725,16 @@ }, { "name": "symfony/polyfill-php80", - "version": "v1.23.0", + "version": "v1.23.1", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php80.git", - "reference": "eca0bf41ed421bed1b57c4958bab16aa86b757d0" + "reference": "1100343ed1a92e3a38f9ae122fc0eb21602547be" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/eca0bf41ed421bed1b57c4958bab16aa86b757d0", - "reference": "eca0bf41ed421bed1b57c4958bab16aa86b757d0", + "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/1100343ed1a92e3a38f9ae122fc0eb21602547be", + "reference": "1100343ed1a92e3a38f9ae122fc0eb21602547be", "shasum": "" }, "require": { @@ -2513,7 +2801,7 @@ "type": "tidelift" } ], - "time": "2021-02-19T12:13:01+00:00" + "time": "2021-07-28T13:41:28+00:00" }, { "name": "symfony/service-contracts", @@ -2593,16 +2881,16 @@ }, { "name": "symfony/string", - "version": "v5.3.3", + "version": "v5.3.10", "source": { "type": "git", "url": "https://github.com/symfony/string.git", - "reference": "bd53358e3eccec6a670b5f33ab680d8dbe1d4ae1" + "reference": "d70c35bb20bbca71fc4ab7921e3c6bda1a82a60c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/string/zipball/bd53358e3eccec6a670b5f33ab680d8dbe1d4ae1", - "reference": "bd53358e3eccec6a670b5f33ab680d8dbe1d4ae1", + "url": "https://api.github.com/repos/symfony/string/zipball/d70c35bb20bbca71fc4ab7921e3c6bda1a82a60c", + "reference": "d70c35bb20bbca71fc4ab7921e3c6bda1a82a60c", "shasum": "" }, "require": { @@ -2669,20 +2957,20 @@ "type": "tidelift" } ], - "time": "2021-06-27T11:44:38+00:00" + "time": "2021-10-27T18:21:46+00:00" }, { "name": "theseer/tokenizer", - "version": "1.2.0", + "version": "1.2.1", "source": { "type": "git", "url": "https://github.com/theseer/tokenizer.git", - "reference": "75a63c33a8577608444246075ea0af0d052e452a" + "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/theseer/tokenizer/zipball/75a63c33a8577608444246075ea0af0d052e452a", - "reference": "75a63c33a8577608444246075ea0af0d052e452a", + "url": "https://api.github.com/repos/theseer/tokenizer/zipball/34a41e998c2183e22995f158c581e7b5e755ab9e", + "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e", "shasum": "" }, "require": { @@ -2715,7 +3003,7 @@ "type": "github" } ], - "time": "2020-07-12T23:59:07+00:00" + "time": "2021-07-28T10:34:58+00:00" }, { "name": "webmozart/assert", @@ -2773,24 +3061,29 @@ }, { "name": "wp-coding-standards/wpcs", - "version": "0.14.1", + "version": "2.2.1", "source": { "type": "git", "url": "https://github.com/WordPress/WordPress-Coding-Standards.git", - "reference": "cf6b310caad735816caef7573295f8a534374706" + "reference": "b5a453203114cc2284b1a614c4953456fbe4f546" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/cf6b310caad735816caef7573295f8a534374706", - "reference": "cf6b310caad735816caef7573295f8a534374706", + "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/b5a453203114cc2284b1a614c4953456fbe4f546", + "reference": "b5a453203114cc2284b1a614c4953456fbe4f546", "shasum": "" }, "require": { - "php": ">=5.3", - "squizlabs/php_codesniffer": "^2.9.0 || ^3.0.2" + "php": ">=5.4", + "squizlabs/php_codesniffer": "^3.3.1" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || ^0.6", + "phpcompatibility/php-compatibility": "^9.0", + "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" }, "suggest": { - "dealerdirect/phpcodesniffer-composer-installer": "^0.4.3" + "dealerdirect/phpcodesniffer-composer-installer": "^0.6 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." }, "type": "phpcodesniffer-standard", "notification-url": "https://packagist.org/downloads/", @@ -2800,7 +3093,7 @@ "authors": [ { "name": "Contributors", - "homepage": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/graphs/contributors" + "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors" } ], "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions", @@ -2809,7 +3102,7 @@ "standards", "wordpress" ], - "time": "2018-02-16T01:57:48+00:00" + "time": "2020-02-04T02:52:06+00:00" }, { "name": "wpreadme2markdown/wp2md", @@ -2910,6 +3203,63 @@ "wordpress" ], "time": "2020-08-07T00:24:42+00:00" + }, + { + "name": "yoast/phpunit-polyfills", + "version": "1.0.2", + "source": { + "type": "git", + "url": "https://github.com/Yoast/PHPUnit-Polyfills.git", + "reference": "1a582ab1d91e86aa450340c4d35631a85314ff9f" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Yoast/PHPUnit-Polyfills/zipball/1a582ab1d91e86aa450340c4d35631a85314ff9f", + "reference": "1a582ab1d91e86aa450340c4d35631a85314ff9f", + "shasum": "" + }, + "require": { + "php": ">=5.4", + "phpunit/phpunit": "^4.8.36 || ^5.7.21 || ^6.0 || ^7.0 || ^8.0 || ^9.0" + }, + "require-dev": { + "yoast/yoastcs": "^2.2.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.x-dev", + "dev-develop": "1.x-dev" + } + }, + "autoload": { + "files": [ + "phpunitpolyfills-autoload.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Team Yoast", + "email": "support@yoast.com", + "homepage": "https://yoast.com" + }, + { + "name": "Contributors", + "homepage": "https://github.com/Yoast/PHPUnit-Polyfills/graphs/contributors" + } + ], + "description": "Set of polyfills for changed PHPUnit functionality to allow for creating PHPUnit cross-version compatible tests", + "homepage": "https://github.com/Yoast/PHPUnit-Polyfills", + "keywords": [ + "phpunit", + "polyfill", + "testing" + ], + "time": "2021-10-03T08:40:26+00:00" } ], "aliases": [], @@ -2918,7 +3268,7 @@ "prefer-stable": false, "prefer-lowest": false, "platform": { - "php": ">=7.1" + "php": ">=7.3" }, "platform-dev": [], "platform-overrides": { diff --git a/footer.php b/footer.php index f32354c..4d36aab 100644 --- a/footer.php +++ b/footer.php @@ -8,6 +8,7 @@ * * @package Aldine */ + ?>
- + diff --git a/functions.php b/functions.php index b6c6864..aae425d 100644 --- a/functions.php +++ b/functions.php @@ -68,11 +68,11 @@ add_action( 'customize_controls_enqueue_scripts', '\Aldine\Customizer\enqueue_co add_action( 'customize_controls_enqueue_scripts', '\Aldine\Customizer\enqueue_contact_form_tweaks' ); add_action( 'customize_controls_enqueue_scripts', '\Aldine\Customizer\enqueue_pb_a11y_in_customizer' ); -// Shortcodes +// Shortcodes. add_shortcode( 'aldine_page_section', '\Aldine\Shortcodes\page_section' ); add_shortcode( 'aldine_call_to_action', '\Aldine\Shortcodes\call_to_action' ); -// Catalog page: Network admin controls +// Catalog page: Network admin controls. add_action( 'admin_enqueue_scripts', '\Aldine\Admin\admin_scripts' ); add_action( 'wp_ajax_pressbooks_aldine_update_catalog', '\Aldine\Admin\update_catalog' ); add_filter( 'wpmu_blogs_columns', '\Aldine\Admin\catalog_columns' ); diff --git a/inc/actions/namespace.php b/inc/actions/namespace.php index 6b10528..203fd6f 100644 --- a/inc/actions/namespace.php +++ b/inc/actions/namespace.php @@ -1,6 +1,7 @@ $page ) { @@ -94,21 +95,21 @@ function create_default_content() { } } - // Set front page to Home + // Set front page to Home. update_option( 'show_on_front', 'page' ); update_option( 'page_on_front', $pages['home'] ); - // Remove content generated by wp_install_defaults + // Remove content generated by wp_install_defaults. wp_delete_post( 1, true ); wp_delete_post( 2, true ); wp_delete_comment( 1, true ); - // Migrate site logo + // Migrate site logo. if ( ! empty( $mods['custom_logo'] ) ) { set_theme_mod( 'custom_logo', $mods['custom_logo'] ); } - // Add "pb_aldine_activated" option to enable check above + // Add "pb_aldine_activated" option to enable check above. add_option( 'pb_aldine_activated', 1 ); } } diff --git a/inc/admin/namespace.php b/inc/admin/namespace.php index 32fd366..8f9cfc3 100644 --- a/inc/admin/namespace.php +++ b/inc/admin/namespace.php @@ -1,5 +1,7 @@ deleteBookFromDirectory( [ $blog_id ] ); + if ( isset( $_POST['book_id'] ) ) { + $blog_id = absint( $_POST['book_id'] ); + } + if ( isset( $_POST['in_catalog'] ) ) { + $in_catalog = wp_unslash( $_POST['in_catalog'] ); + if ( $in_catalog === 'true' ) { + update_blog_option( $blog_id, \Aldine\Admin\BLOG_OPTION, 1 ); + update_site_meta( $blog_id, BookDataCollector::IN_CATALOG, 1 ); + } else { + delete_blog_option( $blog_id, \Aldine\Admin\BLOG_OPTION ); } } + update_site_meta( $blog_id, BookDataCollector::IN_CATALOG, 0 ); + // Exclude book when network option book directory non-catalog exclude is enabled. + $option = get_site_option( 'pressbooks_sharingandprivacy_options', [], true ); + if ( + isset( $option[ SharingAndPrivacyOptions::NETWORK_DIRECTORY_EXCLUDED ] ) && + ( (bool) $option[ SharingAndPrivacyOptions::NETWORK_DIRECTORY_EXCLUDED ] === true ) + ) { + BookDirectory::init()->deleteBookFromDirectory( [ $blog_id ] ); + } update_blog_details( $blog_id, [ 'last_updated' => current_time( 'mysql', true ) ] ); } /** - * @param array $columns + * Catalog columns + * + * @param array $columns Columns * * @return array */ @@ -77,8 +85,10 @@ function catalog_columns( $columns ) { } /** - * @param string $column - * @param int $blog_id + * Catalog column + * + * @param string $column Column + * @param int $blog_id Blog ID */ function catalog_column( $column, $blog_id ) { diff --git a/inc/customizer/namespace.php b/inc/customizer/namespace.php index 450ec33..fa9fd90 100644 --- a/inc/customizer/namespace.php +++ b/inc/customizer/namespace.php @@ -15,12 +15,12 @@ use PressbooksMix\Assets; * @param \WP_Customize_Manager $wp_customize Theme Customizer object. */ function customize_register( \WP_Customize_Manager $wp_customize ) { - // Remove unsupported WP controls, @see \WP_Customize_Manager::register_controls + // Remove unsupported WP controls, @see \WP_Customize_Manager::register_controls. $wp_customize->remove_control( 'display_header_text' ); $wp_customize->remove_control( 'header_textcolor' ); - // Add Pressbooks controls + // Add Pressbooks controls. $wp_customize->get_setting( 'blogname' )->transport = 'postMessage'; $wp_customize->get_setting( 'blogdescription' )->transport = 'postMessage'; @@ -272,6 +272,8 @@ function customize_preview_js() { } /** + * Load color contrast validation tool + * * @see https://github.com/soderlind/customizer-validate-wcag-color-contrast */ function enqueue_color_contrast_validator() { diff --git a/inc/filters/namespace.php b/inc/filters/namespace.php index 1273614..04b1b03 100644 --- a/inc/filters/namespace.php +++ b/inc/filters/namespace.php @@ -66,11 +66,10 @@ function excerpt_more() { /** * Add things to the menu. * - * @param string $items - * @param object $args + * @param string $items Items + * @param object $args Args * @return string */ - function adjust_menu( $items, $args ) { if ( $args->theme_location === 'primary-menu' ) { return \Aldine\Helpers\get_default_menu( $items ); @@ -82,6 +81,7 @@ function adjust_menu( $items, $args ) { /** * Add TinyMCE Buttons. * + * @param array $plugin_array Plugin array * @since 1.1.0 */ function add_buttons( $plugin_array ) { @@ -96,6 +96,7 @@ function add_buttons( $plugin_array ) { /** * Register TinyMCE Buttons. * + * @param array $buttons TinyMCE Buttons * @since 1.1.0 */ function register_buttons( $buttons ) { diff --git a/inc/helpers/namespace.php b/inc/helpers/namespace.php index 855cab5..58ddcc7 100644 --- a/inc/helpers/namespace.php +++ b/inc/helpers/namespace.php @@ -13,11 +13,13 @@ use function \Pressbooks\Utility\str_starts_with; use Pressbooks\DataCollector\Book as BookDataCollector; /** - * @param int $page - * @param int $per_page - * @param string $orderby - * @param string $license - * @param string $subject + * Get catalog data + * + * @param int $page Catalog page + * @param int $per_page Books per page + * @param string $orderby Sort order + * @param string $license Copyright license + * @param string $subject Subject * * @return array */ @@ -27,7 +29,7 @@ function get_catalog_data( $page = 1, $per_page = 10, $orderby = 'title', $licen return [ 'pages' => 0, 'books' => [], - ]; // Bail + ]; } $dc = BookDataCollector::init(); @@ -40,6 +42,8 @@ function get_catalog_data( $page = 1, $per_page = 10, $orderby = 'title', $licen $args = apply_filters( 'pb_aldine_catalog_query_args', /** + * Deprecation notice + * * @deprecated 1.0.0 * * @see Pressbooks Publisher @@ -59,12 +63,16 @@ function get_catalog_data( $page = 1, $per_page = 10, $orderby = 'title', $licen ) ); - /** @var \WP_Site $site */ + /** + * WordPress site + * + * @var \WP_Site $site + */ $sites_in_catalog = []; $sites = get_sites( $args ); foreach ( $sites as $site ) { - $site->pb_title = $dc->get( $site->blog_id, $dc::TITLE ); // Cool hack! :face_with_rolling_eyes: + $site->pb_title = $dc->get( $site->blog_id, $dc::TITLE ); $sites_in_catalog[] = $site; } if ( $orderby === 'latest' ) { @@ -103,7 +111,6 @@ function get_catalog_data( $page = 1, $per_page = 10, $orderby = 'title', $licen ]; } - /** * Get licenses for catalog display. * @@ -123,7 +130,7 @@ function get_catalog_licenses() { /** * Get licenses currently in use. * - * @param array $catalog_data + * @param array $catalog_data Catalog data * * @return array */ @@ -144,7 +151,7 @@ function get_available_licenses( $catalog_data ) { /** * Get subjects currently in use. * - * @param array $catalog_data + * @param array $catalog_data Catalog data * * @return array */ @@ -162,7 +169,7 @@ function get_available_subjects( $catalog_data ) { /** * Return the default (non-page) menu items. * - * @param string $items + * @param string $items Items * * @return string $items */ @@ -269,7 +276,8 @@ function get_default_menu( $items = '' ) { /** * Echo the default menu. * - * @param string $items + * @param array $args Array + * @param string $items Items */ function default_menu( $args = [], $items = '' ) { printf( @@ -345,7 +353,7 @@ function handle_contact_form_submission() { stripslashes( $name ), $email, stripslashes( $institution ), - strip_tags( $message ) + wp_strip_all_tags( $message ) ), "From: ${email}\r\nReply-To: ${email}\r\n" ); diff --git a/inc/shortcodes/namespace.php b/inc/shortcodes/namespace.php index 490a543..4f3424d 100644 --- a/inc/shortcodes/namespace.php +++ b/inc/shortcodes/namespace.php @@ -10,8 +10,8 @@ namespace Aldine\Shortcodes; /** * Shortcode for Page Section. * - * @param array $atts - * @param string $content + * @param array $atts Shortcode attributes + * @param string $content Page content * * @return string */ @@ -36,7 +36,7 @@ function page_section( $atts, $content = null ) { /** * Shortcode for custom Call to Action. * - * @param array $atts + * @param array $atts Shortcode attributes * * @return string */ @@ -51,7 +51,7 @@ function call_to_action( $atts ) { 'aldine_call_to_action' ); - // Fallback for shortcodes using the old url attribute + // Fallback for shortcodes using the old url attribute. if ( $atts['link'] === '#' && $atts['url'] ) { $atts['link'] = $atts['url']; } diff --git a/partials/book.php b/partials/book.php index 6e37702..84da7bc 100644 --- a/partials/book.php +++ b/partials/book.php @@ -1,4 +1,10 @@ @@ -22,13 +28,15 @@ if ( $date ) {

+ /* +

- */ + + */ ?>

diff --git a/partials/contact-form.php b/partials/contact-form.php index c52baf2..8334584 100644 --- a/partials/contact-form.php +++ b/partials/contact-form.php @@ -4,6 +4,7 @@ * * @package Aldine */ + ?> @@ -30,7 +31,7 @@ $honeypot = 'firstname' . rand();

- @@ -46,7 +47,7 @@ $honeypot = 'firstname' . rand();

- @@ -62,7 +63,7 @@ $honeypot = 'firstname' . rand();

- @@ -78,7 +79,7 @@ $honeypot = 'firstname' . rand();

-