What

Bumps the minimum required version to v7.4

Why

• The composer dependencies we'll need for WPUnit tests require v7.4, as do the latest versions of phpstan and phpstan-wordpress.
• WPGraphQL itself requires a minimum v7.3, and is likely to bump to v7.4 in the next breaking release.
• 7.3 reached its EOL a year ago.
• Packagist stats show no usage below v7.4

How

Testing Instructions

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

This PR is a complete refactor of the plugin to bring it up to date with the latest ecosystem patterns, make it more extensible for the future, and most importantly, make it compatible with the latest versions of WPGraphQL.

Note: This PR contains breaking changes to the underlying PHP. The GraphQL schema and usage patterns remain the same.

Highlights.

• The entire plugin is now autoloaded with Composer.
• Class WPGraphQL_FacetWP has been refactored to WPGraphQL\FacetWP\Main.
• GraphQL types have been relocated to individual PHP classes in the WPGraphQL\FacetWP\Type namespace, and registered by WPGraphQL\FacetWP\Registry\TypeRegistry.
• register_graphql_facet_type() has been relocated to access-functions.php and uses WPGraphQL\FacetWP\Registry\FacetRegistry to generate the necessary types.
• All types are now registered on add_action( get_graphql_register_action(), ... ):. Note: As a result facet types are registered late (to be handled in a future PR).
• The minimum WordPress version is now 5.0, and the minimum WPGraphQL version is now 1.6.0. Things should theoretically work in previous WPGraphQL versions.

Screenshot

Additional Notes

• Since WPGraphQL 1.6.0 implements lazy-loading types, the generic FacetWP types will only appear in the schema if register_graphql_facet_type() is called somewhere.
• This PR includes (and depends on) the changes in #27 .
• Ideally this should be merged after some basic WPUnit tests (I don't think I'm familiar enough yet with this plugin to implement them myself) and some GH Actions (e.g schema linting) are in place. This was a big PR and while most underlying cost is the same, just relocated, its better to be safe than sorry.
• Currently the vendor autoloader is included in the repo, to ensure downloading the master branch continues to work. Once we start building releases with a CI, the vendor folder should be excluded from the repo.

This PR:

1. Updates the Plugin Headers with the latest version / requires info.
2. Adds a readme.txt and a stub for CHANGELOG.md
3. Updates composer.json to build deps at PHP v7.1, and adds PHPStan/PHPCS linting.
4. Updates .gitignore and adds .distignore, .gitattributes, and .env.dist files
5. PHPStan / Lint the existing plugin files.

Notes:

• No plugin functionality has been changed. This is strictly housekeeping.
• The plugin version was changed to 0.3.0 - this seems to have been an oversight as the version tag exists.
• The list of ignored files/directories in the various project files includes those that will be used by upcoming PRs (e.g. WPUnit Tests, CI, etc).

Hi there, I added a custom filter that is called facetwp_graphql_facet_connection_config which allows developers to adjust the facet connection configuration. In my case I wanted to use the default woocommerce product graphql connection which is possible with the example in the docs.

Looking forward to your feedback!

What

Version bump.

Testing Instructions

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

What

Adds basic test for register_graphql_facet_type, fixing a few registration issues along the way.

Why

How

Testing Instructions

vendor/bin/codecept run wpunit

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

What

Creates a basic codeception config, with an associated GH workflow.

Why

How

Currently only plugin activation is tested.

Testing Instructions

1. Run composer install
2. setup the test environment with composer install-test-env.
3. Run vendor/bin/codecept run acceptance

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

What

Bumps the pre-refactored plugin version to v0.3.0.1

Why

v0.3.0 was released without bumping the version number from 0.2.0. While normally this wouldn't be a big enough deal to backfill a release, because of the significant changes in #28 we want to make it clear what version users are actually using.

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

What

Runs GH Actions on pull requests with the safe to test ✔ label.

Why

Since we need to use pull_request_target to test against FacetWP with a repo secret, we need a secure way to avoid pwn requests.

How

• ci: only run pull_request_target when the safe to test ✔ label is applied.
• ci: use ramsey/composer-install@v2 to cache dependencies.

Testing Instructions

Additional Info

Checklist:

• [x] My code is tested to the best of my abilities.
• [x] My code follows the WordPress Coding Standards.
• [x] My code has proper inline documentation.

This PR:

• Add scripts to scaffold a test environment via composer or docker.
• Adds GH workflows for PHPStan, GraphQL Schema Linting, and uploading artifacts to releases.

Notes:

• To build a test env, we need to be able to access a copy of facetwp. For local use, just edit .env to point to your gitified copy + PAT, but we need to add some secrets to the repo to get CI to work.
• The workflows are written under the assumption that a main <- dev <- pr-branch merge flow will be adopted for the repo.
• Schema linting and artifact uploading assumes the use of GitHub Releases for version bumps.
• The CI for integration testing will be handled in a separate PR, since currently no tests have been written

This PR adds templates for issues and pull requests, and a workflow for phpcs linting.

Notes:

• Other workflows are dependent on an actual WordPress install, which will require adding a GH secret to the repo to access a copy of facetwp for installation.
• The templates are written under the assumption that GitHub discussions will be enabled for the repo.
• The workflows are written under the assumption that a main <- dev <- pr-branch merge flow will be adopted for the repo.

What problem does this address?

Currently to use this plugin, you need to manually register_graphql_facet_type(), and then query the facet from RootQuery. That's a lot of manual work for the user, as well as more verbose queries.

What is your proposed solution?

We should be able to use the existing FacetWP data to autoregister facets to the schema out of the box, ideally as an input on the connections's {Type}ConnectionWhereArgs.

Similarly, facet data can be added to the connection edge.

E.g.

query GetPosts($query: FacetQueryArgs, $after: String, $search: String, $orderBy: [PostObjectsConnectionOrderbyInput]) {
  posts(first: 10, after: $after, where: {status: PUBLISH, search: $search, orderby: $orderBy, facetQuery: $query }) {
    pageInfo {
      hasNextPage
      endCursor
    }
    selectedFacet {
      name
      label
      choices {
        value
        label
        count
      }
    }
    nodes {
      title
      excerpt
    }
  }
}

What alternatives have you considered?

No response

Additional Context

This would be a non-breaking enhancement

FacetWP has a sort facet that allows you to specify different ways to sort the returned data based on preset sort indexes. It would be great to have a sort GraphQL input type so that the data could be returned based on one of the preset sorts.

I am trying to use your wp-graphql-facetwp plugin and register the "register_graphql_facet_type()". I followed the doc's but get Uncaught Error.

WordPress v5.6 FacetWP v3.7 WPGraphQL v1.0.5

I added the function call in the theme functions.php file. I also have a facet setup.

// Register facet for Posts register_graphql_facet_type( 'post' );

Uncaught Error: Call to undefined function register_graphql_facet_type() Stack trace: #0 wp-settings.php(525): include() #1 wp-config.php(99): require_once('/home/ionicexce...') #2 wp-load.php(37): require_once('/home/ionicexce...') #3 wp-admin/admin.php(34): require_once('/home/ionicexce...') #4 wp-admin/theme-editor.php(10): require_once('/home/ionicexce...') #5 {main}

FacetWP sends through 'yes' and 'no' for some settings. These really should be boolean values on the consumer end. Check other settings for similar issues.