PHPackages                             tomk79/px2-site-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. tomk79/px2-site-search

ActiveLibrary[Search & Filtering](/categories/search)

tomk79/px2-site-search
======================

0.2.3(10mo ago)0220MITPHPPHP >=7.3.0

Since Mar 20Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/tomk79/px2-site-search)[ Packagist](https://packagist.org/packages/tomk79/px2-site-search)[ RSS](/packages/tomk79-px2-site-search/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (15)Versions (8)Used By (0)

px2-site-search
===============

[](#px2-site-search)

[Pickles 2](https://pickles2.com/)に、サイト内検索機能を追加します。

Setup - セットアップ手順
----------------

[](#setup---セットアップ手順)

### [Pickles 2 プロジェクト](https://pickles2.com/) をセットアップ

[](#pickles-2-プロジェクト-をセットアップ)

### 1. `composer.json` に、パッケージ情報を追加

[](#1-composerjson-にパッケージ情報を追加)

```
$ composer require tomk79/px2-site-search
```

### 2. `px-files/config.php` を開き、プラグインを設定

[](#2-px-filesconfigphp-を開きプラグインを設定)

```
$conf->funcs->before_content = array(
    // PX=site_search
    picklesFramework2\px2SiteSearch\register::before_content(array(
        // 検索エンジンの種類
        // - 'client' = ブラウザ上で静的に動作する検索インデックス
        // - 'paprika' = Paprikaフレームワークを用いてサーバー上で動作する検索インデックス
        // 省略時: 'client'
        'engine_type' => 'client',

        // クライアント用アセットを書き出す先のディレクトリ
        // 省略時: '/common/site_search_index/'
        'path_client_assets_dir' => '/common/site_search_index/',

        // 非公開データの書き出し先ディレクトリ
        // 省略時: '/_sys/site_search_index/'
        'path_private_data_dir' => '/_sys/site_search_index/',

        // インデックスから除外するパス
        // 複数のパス(完全一致)、または正規表現で定義します。
        // 省略時: 除外しない
        'paths_ignore' => array(
            '/perfect_match_ignored/ignored.html', // 完全一致 による設定例
            '/^\/ignored\/.*$/i', // 正規表現による設定例
        ),

        // コンテンツエリアを抽出するセレクタ
        // 省略時: 'body'
        'contents_area_selector' => '.contents',

        // コンテンツから除外する要素のセレクタ
        // 省略時: 除外しない
        'ignored_contents_selector' => array(
            '.contents-ignored',
        ),
    )),
);
```

### 3. コンテンツまたはテーマに、検索UIを追加する

[](#3-コンテンツまたはテーマに検索uiを追加する)

```