Location.search - クエリを取得、変更する

投稿日:2016/03/03 / 更新日:2016/03/03

JavaScriptの、Locationオブジェクトのsearchは、クエリ部分を取得、変更するプロパティです。

説明

Locationオブジェクトのsearchプロパティは、クエリの情報を含みます。取得できるのは、?syncer=1&good=trueの部分で、疑問符(?)も含みます。

https://syncer.jp/index.html?syncer=1&good=true#section-1

searchプロパティに新しく値を設定することで現在のクエリを変更、すなわち、ページ移動させることができます。指定する値には疑問符(?)は含めません。

// クエリを変更
window.location.search = "arayutw=2&bad=false" ;

https://syncer.jp/index.html?arayutw=2&bad=false#section-1

クエリ部分を変更してページ移動した場合、クエリ部分だけが変更されて、フラグメント識別子はそのまま引き継がれます。

サンプルコード

https://syncer.jp/index.html?syncer=1&good=true#section-1

// クエリ部分を取得 ( → "syncer=1&good=true" )
var search = window.location.search ;

// クエリ部分を変更 ( → https://syncer.jp/index.html?arayutw=2&bad=false#section-1 )
window.location.search = "arayutw=2&bad=false" ;

デモ

下記はsyncer-editor.com上のページです。window.location.searchを取得して表示します。このページはクエリでページを切り替えているため、変更した場合は他のデモページに移動します。フラグメント識別子がそのまま引き継がれるのを確認したい場合は、お手数ですが、新しいウィンドウを開いてお試し下さい。

RUN
HTML
CSS
JavaScript

<p><a href="" target="_blank" class="hyperlink">新しいウィンドウで開く</a></p> <p><a href="#top" class="hyperlink">#top</a></p> <p id="output" class="output"></p> <p id="error" class="error none"></p> <p><button id="get" class="button">取得</button></p> <p><button id="set" class="button">変更</button></p> <p><button id="reset" class="button">リセット</button></p>

.output { color: #333 ; text-align: center ; padding: 8px 0 ; border: 1px solid #333 ; min-height: 24px ; } .hyperlink { font-size: 16px ; font-weight: 700 ; } .error { color: #f00 ; padding: 8px 12px ; border: 1px solid #333 ; min-height: 24px ; } .button { color: #333 ; display: block ; background: #f2f2f2 ; text-align: center ; padding: 8px ; font-size: 1rem ; font-weight: 700 ; border: 1px solid #e6e6e6 ; width: 100% ; box-sizing: border-box ; } .button:hover { cursor: pointer ; background: #e6e6e6 ; } .none { display: none ; } html{ font:400 14px / 1.618 ArialMT,"Hiragino Kaku Gothic ProN","ヒラギノ角ゴ ProN W3","Hiragino Kaku Gothic Pro W3","ヒラギノ角ゴ Pro W3","メイリオ","ＭＳＰゴシック","Osaka" ; }

// 取得 document.getElementById( "get" ).addEventListener( "click", function() { try { // クエリ部分を取得 ( → "https:" ) var search = window.location.search ; // 取得した要素を出力 document.getElementById( "output" ).textContent = search ; // コンソールで内容を出力 console.log( search ) ; // エラーを非表示 errorElement.className = "error none" ; // エラー表示 } catch ( msg ) { errorElement.className = "error" ; errorElement.textContent = msg ; console.error( msg ) ; } } ) ; // 変更 document.getElementById( "set" ).addEventListener( "click", function() { try { // クエリ部分を変更 window.location.search = "id=704&templete=0&referer=%2Fjavascript-reference%2Flocation%2Fpathname" ; // エラーを非表示 errorElement.className = "error none" ; // エラー表示 } catch ( msg ) { errorElement.className = "error" ; errorElement.textContent = msg ; console.error( msg ) ; } } ) ; // リロード document.getElementById( "reset" ).addEventListener( "click", function() { initialize() ; } ) ; // エラー表示用の要素 var errorElement = document.getElementById( "error" ) ; // 初期化 function initialize() { errorElement.className = "error none" ; document.getElementById( "output" ).innerHTML = "" ; }

構文

string search = Location.search
Location.protocol = string newSearch

返り値

項目	説明
search	現在のURLのクエリ部分。先頭の疑問符(`?`)が含まれる。

指定する値

項目	説明
newSearch	新しく設定したいクエリ部分。先頭の疑問符(`?`)を含めない。

外部リンク

HTML Living Standard - WHATWGによる仕様書。

説明

サンプルコード

デモ

構文

返り値

指定する値

関連項目

外部リンク