Download the PHP package valu/wp-valu-search without Composer

On this page you can find all versions of the php package valu/wp-valu-search. 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 valu/wp-valu-search

Informations about the package wp-valu-search

🚨 This plugin has been deprecated. Please move the to Findkit plugin as soon as possible.

https://github.com/findkit/wp-findkit

Valu Search for WordPress

WordPress plugin for Valu Search.

This plugin has two features

This plugin does not provide any UI. It just exposes some config options and filters for developers.

Installation

It's on Packagist

composer require valu/wp-valu-search

If not using composer download a .zip from the releases page and extract it to wp-content/plugins.

Hacking

The plugin adds a script tag to pages on your site.

If you wish to test the plugin behaviour on your site after installing it, simply refresh page, and look for script tag with id="valu-search".

Live Updates

Live updates are sent optimistically whenever the plugin thinks the content might have changed on a page. The cloud backend then does a scraping request on the page to determine what the update actually was (add, update, delete) if any.

To enable the real time updates add provided credentials to the wp-config:

There's a filter for controlling the update process.

In the event of changing posts/pages permalink the new url gets indexed, but the old url remains in the index until the next full site crawl.

In the event that the changed page was of a hierarchical post type, only the updated page gets reindexed. Other pages that depend on slug of the changed page, eg. child pages get updated during next full crawl.

JWT Authentication

The search endpoint access can be limited using a JWT authentication. This plugin can automatically generate JWT tokens for the @valu/react-valu-search package.

The token are generated only for logged in users but it can be customized with valu_search_allow_search_jwt filter.

Add this to wp-config.php to enable it:

This feature requires PHP-JWT to be installed.

Filters

valu_search_content_selector

Parameters

Multiple selectors can be separated by comma. Ex. .content,.main

valu_search_no_highlight_content_selector

Parameters

Multiple selectors can be separated by comma. Ex. .content,.main

Matching html content is indexed separately from previous valu_search_content_selector. Content is not highlighted in the search ui, but behaves exactly like other content including being searchable and language analyzed.

valu_search_cleanup_selector

Parameters

Remove content from selected elements.

valu_search_show_in_search

Parameters

$show is false if post status is not public OR if the post is archive.

valu_search_title

Parameters

By default HTML entities in $title are decoded using html_entity_decode. To use HTML entities in titles filter $title through htmlentities.

valu_search_created

Parameters

valu_search_modified

Parameters

valu_search_tags

Parameters

List of tags the page gets indexed with. By default the post type, taxonomy terms, static wordpress and public / private tags are added. These tags can be used to build custom filtering UIs.

valu_search_custom_fields

Parameters

Custom fields related to the page.

valu_search_custom_fields_date

Parameters

Custom date fields related to the page. e.g. eventStart, eventEnd

valu_search_custom_fields_keyword

Parameters

Custom keyword fields related to the page. e.g. productPreview, productId

valu_search_custom_fields_number

Parameters

Custom number fields related to the page. e.g. productPrice

valu_search_superwords

Parameters

List of superwords indexed with the page. By default empty array. Superwords can be used to mark page as an important search result for the superwords given. Search results with matching superwords are shown first in results.

valu_search_page_meta

The full data rendered to the meta tag.

See all available fields on https://search.valu.pro/page-meta

valu_search_site_meta

Global options for the crawler exposed on yoursite.example/valu-search.json.

See all available fields on https://search.valu.pro/site-meta

valu_search_should_update

Parameters

Return false to prevent the page from being updated.

'valu_search_show_admin_notices'

Return true to enable notices about live updates in wp-admin

Actions

'valu_search_live_update_result'

Action is fired everytime live update request is done

API

\ValuSearch\enqueue_live_update(\WP_Post $post)

Enqueues a post live update to be sent at the end of the WordPress request in the shutdown action. Can be called multiple times and the update will be batched.

\ValuSearch\live_update(array $posts)

Immediately live update the given posts.

All versions of wp-valu-search with dependencies

PHP Build Version
Package Version
Requires composer/installers Version ~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 valu/wp-valu-search contains the following files

Loading the files please wait ....