【JavaScript】配列の先頭に要素を追加するunshiftメソッドを解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 JavaScriptで配列の先頭に要素を追加するunshiftメソッドについて

unshiftメソッドとは
unshiftメソッドを使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
unshiftメソッドとは
unshiftメソッドを解説するプログラムの概要
1. HTMLサンプルプログラム
2. JavaScriptサンプルプログラム
実行結果
まとめ：unshiftメソッドを使ってみよう

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10

unshiftメソッドとは

unshiftメソッドとは、呼び出した配列の先頭に引数の要素を追加し、追加後の配列の要素数を返すメソッドです。

使い方は以下になります。

var sample = [1, 2, 3, 4]
var result = sample.unshift(0)

1 2	var sample = [1, 2, 3, 4] var result = sample.unshift(0)

変数resultには5が返され、配列sampleは

[0, 1, 2, 3, 4]

1	[0, 1, 2, 3, 4]

になります。

unshiftメソッドの引数には複数指定でき、指定した値すべてが呼び出した配列の先頭に追加されます。

では、次の章で実際に使ってみます。

unshiftメソッドを解説するプログラムの概要

unshiftメソッドを解説するプログラムでは、

HTML
JavaScript

の2ファイルを使います。

unshiftメソッドでの追加前後の配列の中身をHTMLに表示させます。

フォルダ構成は以下のようになっています。
unshiftメソッドを解説するフォルダ構成

HTMLサンプルプログラム

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>unshiftメソッドサンプル</title>
    </head>
    <body>
        <h2>unshiftメソッドで追加する前の配列</h2>
        <div id="unshiftArryBefore"></div>
        <h2>unshiftメソッドで追加した後の配列</h2>
        <div id="unshiftArryAfter"></div>
        <h2>unshiftメソッドで追加後の配列の要素数</h2>
        <div id="unshiftElm"></div>
        <script src="js\sample_javascript.js"></script>
    </body>
</html>

<!DOCTYPE html>

<html>

<head>

<title>unshiftメソッドサンプル</title>

</head>

<body>

<h2>unshiftメソッドで追加する前の配列</h2>

<h2>unshiftメソッドで追加した後の配列</h2>

<h2>unshiftメソッドで追加後の配列の要素数</h2>

</body>

</html>

HTMLで外部のJavaScriptを読み込むやり方は、以下の記事をご参考ください。

HTMLで外部のJavaScriptを読み込むやり方を解説します

JavaScriptサンプルプログラム

var animals = ['イヌ', 'ネコ', 'ハムスター']

// 追加前の状態を表示
var unshiftArryBefore = document.getElementById('unshiftArryBefore')
unshiftArryBefore.innerHTML = "[" + animals + "]"

// 要素を追加
var unshiftNum = animals.unshift('インコ', 'モルモット')

// 追加後の状態を表示
var unshiftArryAfter = document.getElementById('unshiftArryAfter')
unshiftArryAfter.innerHTML = "[" + animals + "]"

var unshiftElm = document.getElementById('unshiftElm')
unshiftElm.innerHTML = unshiftNum

var animals = ['イヌ', 'ネコ', 'ハムスター']

// 追加前の状態を表示

var unshiftArryBefore = document.getElementById('unshiftArryBefore')

unshiftArryBefore.innerHTML = "[" + animals + "]"

// 要素を追加

var unshiftNum = animals.unshift('インコ', 'モルモット')

// 追加後の状態を表示

var unshiftArryAfter = document.getElementById('unshiftArryAfter')

unshiftArryAfter.innerHTML = "[" + animals + "]"

var unshiftElm = document.getElementById('unshiftElm')

unshiftElm.innerHTML = unshiftNum

getElementByIdメソッド
innerHTMLプロパティ

については、こちらの記事をご参考ください。

getElementByIdメソッド
【JavaScript】指定したidの要素を取得するgetElementByIdメソッドについて解説します

innerHTMLプロパティ
【JavaScript】HTML要素の取得や書き換えができるinnerHTMLプロパティを解説します

実行結果

作成したHTMLをブラウザで開きます。

JavaScriptのunshiftメソッドの実行確認

unshiftメソッドによって、配列の先頭に指定した値が追加できていることが確認できました。

まとめ：unshiftメソッドを使ってみよう

以上がJavaScriptのunshiftメソッドについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ