Download the PHP package hsimah-services/wp-graphql-facetwp without Composer

On this page you can find all versions of the php package hsimah-services/wp-graphql-facetwp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hsimah-services/wp-graphql-facetwp

Informations about the package wp-graphql-facetwp

WPGraphQL for FacetWP

Adds WPGraphQL support for FacetWP.

Packagist License Packagist Version GitHub commits since latest release (by SemVer) GitHub forks GitHub Repo stars
CodeQuality GitHub Workflow Status Coding Standards

Overview

This plugin exposes configured facets through the graph schema. Once registered for a type, a query is available. The payload includes both facet choices and information and a connection to the post type data. This allows for standard GraphQL pagination of the returned data set.

This plugin has been tested and is functional with SearchWP.

System Requirements

Quick Install

  1. Install & activate WPGraphQL.
  2. Install & activate FacetWP.
  3. Download the wp-graphql-facetwp.zip file from the latest release upload it to your WordPress install, and activate the plugin.

[!IMPORTANT]

Make sure you are downloading the wp-graphql-facetwp.zip file from the releases page, not the Source code (zip) file nor a clone of the repository.

If you wish to use the source code, you will need to run composer install inside the plugin folder to install the required dependencies.

With Composer

Updating and Versioning

As we work towards a 1.0 Release, we will need to introduce numerous breaking changes. We will do our best to group multiple breaking changes together in a single release, to make it easier on developers to keep their projects up-to-date.

Until we hit v1.0, we're using a modified version of SemVer, where:

Development and Support

WPGraphQL for FacetWP was initially created by Hamish Blake. Maintainance and development are now provided by AxePress Development. Community contributions are welcome and encouraged.

Basic support is provided for free, both in this repo and at the #facetwp channel in WPGraphQL Slack.

Priority support and custom development is available to AxePress Development sponsors.

Usage:

Registering a facet to WPGraphQL

It is assumed that facets have been configured.

To register a FacetWP query in the WPGraphQL schema for a WordPress post type (eg post) simply call the following function:

This will create a WPGraphQL postFacet field on the RootQuery. The payload includes a collection of queried facets and a posts connection. The connection is a standard WPGraphQL connection supporting pagination and server side ordering. The connection payload only includes filtered posts.

Example query

Note This is not a complete list of GraphQL fields and types added to the schema. Please refer to the WPGraphiQL IDE for more queries and their documentation.

WooCommerce Support

Support for WooCommerce Products can be added with following configuration:

Limitations

Currently the plugin only has been tested using Checkbox, Radio, and Sort facet types. Support for additional types is in development.

Testing

  1. Update your .env file to your testing environment specifications.
  2. Run composer install-test-env to create the test environment.
  3. Run your test suite with Codeception. E.g. vendor/bin/codecept run wpunit will run all WPUnit tests.

All versions of wp-graphql-facetwp with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
axepress/wp-graphql-plugin-boilerplate Version ^0.1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hsimah-services/wp-graphql-facetwp contains the following files

Loading the files please wait ....