findkit / wp-findkit
WordPress plugin for findkit.com
Installs: 8 877
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Type:wordpress-plugin
Requires
- firebase/php-jwt: ^6.3
Requires (Dev)
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.10
- szepeviktor/phpstan-wordpress: ^1.3
- valu/wp-codesniffer-rules: dev-master
- dev-main
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.2
- v1.0.1
- v1.0.0
- v0.5.10
- v0.5.9
- v0.5.8
- v0.5.7
- v0.5.6
- v0.5.5
- v0.5.4
- v0.5.3
- v0.5.2
- v0.5.1
- v0.5.0
- v0.4.0
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.8
- v0.2.7
- v0.2.6
- v0.2.5
- v0.2.4
- v0.2.3
- v0.2.2
- v0.2.1
- v0.2.0
- v0.1.13
- v0.1.12
- v0.1.11
- v0.1.10
- v0.1.9
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- dev-release/1.3.0
- dev-dependabot/npm_and_yarn/findkitui-53a5945717
- dev-release/1.2.0
- dev-release/1.1.0
- dev-release/1.0.2
- dev-release/1.0.1
- dev-release/1.0.0
- dev-release/0.5.10
- dev-release/0.5.9
- dev-release/0.5.8
- dev-release/0.5.7
- dev-release/0.5.6
- dev-release/0.5.5
- dev-release/0.5.4
- dev-release/0.5.3
- dev-release/0.5.2
- dev-release/0.5.1
- dev-release/0.5.0
- dev-release/0.4.0
- dev-release/0.3.2
- dev-release/0.3.1
- dev-release/0.3.0
- dev-release/0.2.8
- dev-release/0.2.7
- dev-release/0.2.6
- dev-release/0.2.5
- dev-release/0.2.4
- dev-release/0.2.3
- dev-release/0.2.2
- dev-release/0.2.1
- dev-release/0.2.0
- dev-esamattis/wp-plugin-dir-fixes
- dev-release/0.1.13
- dev-release/0.1.12
- dev-release/0.1.11
- dev-esamattis/search-trigger-fixes
- dev-release/0.1.10
- dev-release/0.1.9
- dev-release/0.1.8
- dev-release/0.1.7
- dev-release/0.1.6
- dev-release/0.1.5
- dev-release/0.1.4
- dev-release/0.1.3
- dev-release/0.1.2
- dev-stable
This package is auto-updated.
Last update: 2024-11-13 08:03:00 UTC
README
See findkit.com and docs.findkit.com.
Try the plugin right now in the WordPress Playground:
https://playground.wordpress.net/?plugin=findkit
Install
Get zip file from releases or install using Composer
composer require findkit/wp-findkit
Note that this assumes you have configured extra.installer-paths
for WordPress
plugins in your main composer.json. See this article
for details.
Page Meta
The plugin automatically exposes basic Findkit Page Meta by generating the Findkit Meta Tag.
Following fields are automatically added
showInSearch
: Archive pages are automatically excludedtitle
: Clean page titlecreated
: Created timemodified
: Modified timelangugage
: Language from the post or Polylangtags
: Some basic tags including public taxonomies
These can be modified and other fields can be added using the
findkit_page_meta
filter.
add_filter('findkit_page_meta', function ($meta, $post) { $meta['title'] = 'My custom title'; return $meta; }, 10, 2);
Live Update
The plugin can automatically trigger near instant recrawls as pages are being created/edited/deleted. Enable live update in the plugin settings.
JWT Authentication
The Findkit Search Endpoint can be configured to require JWT token authentication.
Setup
This plugin automatically generates a private / public key pair to the
findkit_pubkey
and findkit_privkey
options. Add the public key to the
findkit.toml
file and set the endpoint to private:
[search-endpoint] private = true public_key = """ -----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAvbvzQ+AsMP0UnNpXmk4P 39O3M6SHkcqtP3e6TR/S1LI6cVFF/QdentwYYIABUwbEzxJuYWP6v/BLittCAWSg YsrbImrGHokgO/ItOU/90DrBL+sL6eeMTfECe9guM5l3JrhE70z9dCuQn6GYp8CL VAJWdLKCgmReTvEVQTwFObLpWh4YniXuWnYkw9MPxADLXkJU8MjDlwcIumQMaesP POBVjVuPhtQ+i5V6G2BegemXl8ep6qQ2xt8spNRoAKwt6Nekt5+GWz65Q9juTGdD 6HkR15ij6sSZoOjjSWuiR0CDOhmjDXGCLtqQuLivFq6oGNgP7BqXtoR6hNwSXLSj eFhoszDoQZjRoL7oJ/dE60wxuB8FG5duam+AXx/3IJl93sAeFWFzLPpXYmdXQVG7 2kADsYCcNgdN2RMuKGjg4Qmu/RWKzzFfI7GbNS6K47Ow0VjmSN1pb3UitTkROjAj tPsFXX8vhV1AG9w327Wl/R4d45nd9m/dEaUPpej32caqHtWjQsVT/Sry/ZXhxzaD 4OO7YhKjEbvvHMkgTzihKAKFDIhR+revbgjAPPuwKxseiTrAeKIXDHAW4FVzUq1r 2c+CmzKcwnTle2ydkpCZhGENvqNEgRiGoj5BC5r0gYImsSQyB3B2obvOqtsXOwjn TtZof/qoIldypZCe7BA5ETECAwEAAQ== -----END PUBLIC KEY----- """
You can get the public key value with the wp cli for example.
wp option get findkit_pubkey
and deploy the change.
Put the findkit project id to findkit_project_id
and set findkit_enable_jwt
to a truthy value to enable JWT token generation which will be automatically
picked by the @findkit/ui
library.
wp option set findkit_project_id 'plnGp6Rv0'
wp option set findkit_enable_jwt 1
Authentication
By default this plugin allows only users logged in to use the search endpoint but it can be modified using the findkit_allow_jwt
filter:
add_filter('findkit_allow_jwt', function ($allow) { return current_user_can('edit_posts'); }, 10, 1);
Whitelabel
Wp-findkit plugin like the findkit service is a whitelabel product. You can customize the displayed name with filters.
Ex. Renaming page sidebar settings:
add_filter('gettext_with_context_findkit', function($translation, $text, $context) { if ('Findkit' === $text && 'Sidebar options label' === $context){ return 'My Product Name'; } return $translation; }, 10, 3);