当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「テンプレートタグ/wp get archives」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Template Tags/wp_get_archives 2007年6月10日 (日) 15:42 MichaelH 版)
 
(20:03, 18 February 2016‎ ZacharyR)
 
(4人の利用者による、間の6版が非表示)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
This function displays a date-based archives list in the same way as [[Template_Tags/get_archives|get_archives()]]. The only difference is that parameter arguments are given to the function in query string format.  This tag can be used anywhere within a template.
+
この関数 [[テンプレートタグ/wp_get_archives|wp_get_archives()]] は日付ベースのアーカイブリストを表示します。これはテンプレートのどこでも使えます。
  
== Usage ==
+
'''参考:'''この関数は、非推奨になった [[テンプレートタグ/get_archives|get_archives()]] の後継です。違いは、パラメータの引数をクエリ文字列形式または配列形式で関数に渡すことだけです。
  
%%% <?php wp_get_archives('arguments'); ?> %%%
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
 +
 
 +
<?php wp_get_archives( $args ); ?>
 +
 
 +
<div id="Default_Usage">
 +
=== 初期設定での使用 ===
 +
</div>
  
== Examples ==
 
===Default Usage===
 
 
<pre>
 
<pre>
$defaults = array('type' => 'monthly', 'limit' => '', 'format' => 'html',  
+
<?php
  'before' => '', 'after' => '', 'show_post_count' => false);</pre>
+
$args = array(
By default, the usage shows:
+
'type'           => 'monthly',
* Monthly archives links displayed
+
'limit'           => '',
* Displays all archives (not limited in number)
+
'format'         => 'html',  
* Displays archives in an <nowiki><li></nowiki> HTML list
+
'before'         => '',
* Nothing displayed before or after each link
+
'after'           => '',
* Does not display the count of the number of posts
+
'show_post_count' => false,
 +
'echo'            => 1,
 +
'order'          => 'DESC',
 +
'post_type'    => 'post'
 +
);
 +
wp_get_archives( $args );
 +
?>
 +
</pre>
  
<?php wp_get_archives(); ?>
+
デフォルトのままで使うと、次のとおり表示します。
 +
* 月別アーカイブのリンクを表示
 +
* 全アーカイブを表示(表示数の制限なし)
 +
* HTML の <code><nowiki><li></nowiki></code>(番号なし箇条書き)リストでアーカイブを表示
 +
* 各リンクの前後に何も表示しない
 +
* 投稿数を表示しない
 +
* 降順に表示(新しい月を先に)
  
===Last Twelve Months===
+
<div id="Parameters">
  
Displays archive list by month, displaying only the last twelve.
+
== パラメータ ==
 +
</div>
  
&lt;p&gt;<?php wp_get_archives('type=monthly&limit=12'); ?>&lt;/p&gt;
+
; type : (''文字列'') 表示するアーカイブリストの種類。初期値は月別アーカイブ。有効な値は:
 +
:* <code>yearly</code>
 +
:* <code>monthly</code> (初期値)
 +
:* <code>daily</code>
 +
:* <code>weekly</code>
 +
:* <code>postbypost</code> (投稿を公開日時の順に)
 +
:* <code>alpha</code> (投稿をタイトルのアルファベット順に)
  
===Last Fifteen Days===
+
; limit : (''整数'') 取得するアーカイブ数。初期値は制限なし。
  
Displays archive list by date, displaying only the last fifteen days.
+
; format : (''文字列'') アーカイブリストの形式。有効な値は:
 +
:* <code>html</code> (初期値) - 前後に '''before''' と '''after''' の文字列を付け、HTML のリストタグ(<code><nowiki><li></nowiki></code>)で囲む。
 +
:* <code>option</code> - セレクトボックスまたはドロップダウンメニュー用のセレクトタグ(<code><nowiki><select></nowiki></code>)内で使用するために、前後に '''before''' と '''after''' の文字列を付けてオプションタグ(<code><nowiki><option></nowiki></code>)で囲む。
 +
:* <code>link</code> - リンクタグ(<code><nowiki><link></nowiki></code>)に入れる。
 +
:* <code>custom</code> - 前後に '''before''' と '''after''' の文字列を付けたカスタムリスト。
  
&lt;p&gt;<?php wp_get_archives('type=daily&limit=15'); ?>&lt;/p&gt;
+
; before : (''文字列'') '''format''' オプションが <tt>html</tt> または <tt>custom</tt> のとき、リンクの前に付けるテキスト。デフォルトは空文字列。
  
===Last Twenty Posts===
+
; after : (''文字列'') '''format''' オプションが <tt>html</tt> または <tt>custom</tt> のとき、リンクの後に付けるテキスト。デフォルトは空文字列。
  
Displays archive list of the last twenty most recent posts listed by post title.
+
; show_post_count : (''真偽値'') 投稿数を表示するかどうか。'''type''' オプションが <tt>'postbypost'</tt> のときは無視される。
 +
:* <tt>1 (True)</tt> - 表示する
 +
:* <tt>0 (False)</tt> - 表示しない(初期値)
  
&lt;p&gt;<?php wp_get_archives('type=postbypost&limit=20&format=custom'); ?>&lt;/p&gt;
+
; echo : (''真偽値'') 表示するか、値として返すか。
 +
:* <tt>1 (True)</tt> - 表示する(初期値)
 +
:* <tt>0 (False)</tt> - 表示せず値として返す
  
===Dropdown Box===
+
; order : (''文字列'') リンクリストの順序([[Version 3.5|バージョン 3.5]] 以降)
Displays a dropdown box of Monthly archives, in select tags, with the post count displayed.
+
:* <tt>'ASC'</tt> - 昇順(A から Z へ)
 +
:* <tt>'DESC'</tt> - 降順(Z から A へ)(デフォルト)
 +
 
 +
; post_type : ("string") Limit archives to a post type. Default is 'post'. (since [[Version 4.4]])
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
<pre>
 +
<?php
 +
$my_archives=wp_get_archives(array(
 +
    'type'=>'alpha',  
 +
    'show_post_count'=>true,  
 +
    'limit'=>20,
 +
    'post_type'=>'post',
 +
    'format'=>'html'
 +
));
 +
   
 +
print_r($my_archives);
 +
?>
 +
</pre>
 +
 
 +
</div>
 +
 
 +
<div id="Last_Twelve_Months">
 +
=== 最近 12 ヵ月 ===
 +
</div>
 +
 
 +
この 12 ヵ月の月別アーカイブリストを表示します。投稿のない月は表示しません。
 +
 
 +
<pre>
 +
<ul><?php wp_get_archives( 'type=monthly&limit=12' ); ?></ul>
 +
</pre>
 +
または
 +
<pre>
 +
<ul><?php wp_get_archives( array( 'type' => 'monthly', 'limit' => 12 ) ); ?></ul>
 +
</pre>
 +
 
 +
<div id="Last_Fifteen_Days">
 +
=== 最近 16 日 ===
 +
</div>
 +
 
 +
この 16日の日別アーカイブリストを表示します。
 +
 
 +
<pre>
 +
<ul><?php wp_get_archives( 'type=daily&limit=16' ); ?></ul>
 +
</pre>
 +
または
 +
<pre>
 +
<ul><?php wp_get_archives( array( 'type' => 'daily', 'limit' => 16 ) ); ?></ul>
 +
</pre>
 +
 
 +
<div id="Last_Twenty_Posts">
 +
=== 最近の投稿 20 件 ===
 +
</div>
 +
 
 +
最新 20 件の投稿記事タイトルの一覧を表示します。
 +
 
 +
<pre>
 +
<ul><?php wp_get_archives( 'type=postbypost&limit=20&format=custom' ); ?></ul>
 +
</pre>
 +
または
 +
<pre>
 +
<ul><?php wp_get_archives( array( 'type' => 'postbypost', 'limit' => 20, 'format' => 'custom' ) ); ?></ul>
 +
</pre>
 +
 
 +
<div id="Dropdown_Box">
 +
=== ドロップダウンボックス ===
 +
</div>
 +
 
 +
月別アーカイブのドロップダウンボックス(ドロップダウンメニュー)を表示、各選択肢に投稿数を表示します。
 
<pre>
 
<pre>
 
<select name="archive-dropdown" onChange='document.location.href=this.options[this.selectedIndex].value;'>  
 
<select name="archive-dropdown" onChange='document.location.href=this.options[this.selectedIndex].value;'>  
 
   <option value=""><?php echo attribute_escape(__('Select Month')); ?></option>  
 
   <option value=""><?php echo attribute_escape(__('Select Month')); ?></option>  
   <?php wp_get_archives('type=monthly&format=option&show_post_count=1'); ?> </select>
+
   <?php wp_get_archives( 'type=monthly&format=option&show_post_count=1' ); ?>
 +
</select>
 +
</pre>
 +
または
 +
<pre>
 +
<select name="archive-dropdown" onchange="document.location.href=this.options[this.selectedIndex].value;">
 +
  <option value=""><?php echo esc_attr( __( 'Select Month' ) ); ?></option>
 +
  <?php wp_get_archives( array( 'type' => 'monthly', 'format' => 'option', 'show_post_count' => 1 ) ); ?>
 +
</select>
 
</pre>
 
</pre>
  
== Parameters ==
+
<div id="To_display_the_*ALL*_posts_alphabetically">
 +
=== すべての投稿をアルファベット順に ===
 +
</div>
  
; type : (''string'') The type of archive list to display. Defaults to WordPress settings. Valid values:
+
'''すべての'''投稿をアルファベット順に表示します。サイトマップ風のアーカイブ表示になります。
:* <tt>yearly</tt>
+
<pre>
:* <tt>monthly</tt> (Default)
+
<?php wp_get_archives( 'type=alpha' ); ?>
:* <tt>daily</tt>
+
</pre>
:* <tt>weekly</tt>
+
:* <tt>postbypost</tt>
+
; limit : (''integer'') Number of archives to get. Default is no limit.
+
; format : (''string'') Format for the archive list. Valid values:
+
:* <tt>html</tt> - In HTML list (&lt;li&gt;) tags and '''before''' and '''after''' strings. This is the default.
+
:* <tt>option</tt> - In select (&lt;select&gt;) or dropdown option (&lt;option&gt;) tags.
+
:* <tt>link</tt> - Within link (&lt;link&gt;) tags.
+
:* <tt>custom</tt> - Custom list using the '''before''' and '''after''' strings.
+
; before : (''string'') Text to place before the link when using the <tt>html</tt> or <tt>custom</tt> for '''format''' option. There is no default.
+
; after : (''string'') Text to place after the link when using tge <tt>html</tt> or <tt>custom</tt> for '''format''' option. There is no default.
+
; show_post_count : (''boolean'') Display number of posts in an archive (<tt>1</tt> - true) or do not (<tt>0</tt> - false). For use with all '''type''' except <tt>'postbypost'</tt>. Defaults to <tt>0</tt>.
+
  
== Related ==
+
== 参考 ==
  
{{Tag General Tags}}
+
[[関数リファレンス/get_archives_link|<code>get_archives_link()</code>]] を呼び出して、一つ一つのアーカイブリンクの文字列を組み立てます。
 +
 
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
 +
* [[Version 4.4|4.4.0]]:  'post_type'パラメータを追加しました。
 +
* [[Version 3.5|3.5.0]] : 'order' パラメータを追加しました。
 +
* [[Version 1.2|1.2.0]] : 新規導入。
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>wp_get_archives()</tt> は {{Trac|wp-includes/general-template.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
* [[関数リファレンス/get_archives_link|<code>get_archives_link()</code>]]
 +
{{Lists Tags}}
  
 
{{Query String Tag Footer}}
 
{{Query String Tag Footer}}
 +
 +
{{原文|Function Reference/wp_get_archives|152647}} <!-- 20:38, 19 July 2015‎ Devonmather 版 -->
 +
 +
{{DEFAULTSORT:Wp_get_archives}}
 +
[[Category:テンプレートタグ]]
 +
 +
[[en:Function Reference/wp_get_archives]]
 +
[[id:Tag Templat/wp_get_archives]]

2016年11月18日 (金) 13:46時点における最新版

この関数 wp_get_archives() は日付ベースのアーカイブリストを表示します。これはテンプレートのどこでも使えます。

参考:この関数は、非推奨になった get_archives() の後継です。違いは、パラメータの引数をクエリ文字列形式または配列形式で関数に渡すことだけです。

使い方

<?php wp_get_archives( $args ); ?>

初期設定での使用

<?php
$args = array(
	'type'            => 'monthly',
	'limit'           => '',
	'format'          => 'html', 
	'before'          => '',
	'after'           => '',
	'show_post_count' => false,
	'echo'            => 1,
	'order'           => 'DESC',
	'post_type'     => 'post'
);
wp_get_archives( $args );
?>

デフォルトのままで使うと、次のとおり表示します。

  • 月別アーカイブのリンクを表示
  • 全アーカイブを表示(表示数の制限なし)
  • HTML の <li>(番号なし箇条書き)リストでアーカイブを表示
  • 各リンクの前後に何も表示しない
  • 投稿数を表示しない
  • 降順に表示(新しい月を先に)

パラメータ

type 
(文字列) 表示するアーカイブリストの種類。初期値は月別アーカイブ。有効な値は:
  • yearly
  • monthly (初期値)
  • daily
  • weekly
  • postbypost (投稿を公開日時の順に)
  • alpha (投稿をタイトルのアルファベット順に)
limit 
(整数) 取得するアーカイブ数。初期値は制限なし。
format 
(文字列) アーカイブリストの形式。有効な値は:
  • html (初期値) - 前後に beforeafter の文字列を付け、HTML のリストタグ(<li>)で囲む。
  • option - セレクトボックスまたはドロップダウンメニュー用のセレクトタグ(<select>)内で使用するために、前後に beforeafter の文字列を付けてオプションタグ(<option>)で囲む。
  • link - リンクタグ(<link>)に入れる。
  • custom - 前後に beforeafter の文字列を付けたカスタムリスト。
before 
(文字列) format オプションが html または custom のとき、リンクの前に付けるテキスト。デフォルトは空文字列。
after 
(文字列) format オプションが html または custom のとき、リンクの後に付けるテキスト。デフォルトは空文字列。
show_post_count 
(真偽値) 投稿数を表示するかどうか。type オプションが 'postbypost' のときは無視される。
  • 1 (True) - 表示する
  • 0 (False) - 表示しない(初期値)
echo 
(真偽値) 表示するか、値として返すか。
  • 1 (True) - 表示する(初期値)
  • 0 (False) - 表示せず値として返す
order 
(文字列) リンクリストの順序(バージョン 3.5 以降)
  • 'ASC' - 昇順(A から Z へ)
  • 'DESC' - 降順(Z から A へ)(デフォルト)
post_type 
("string") Limit archives to a post type. Default is 'post'. (since Version 4.4)

用例

<?php 
$my_archives=wp_get_archives(array(
    'type'=>'alpha', 
    'show_post_count'=>true, 
    'limit'=>20, 
    'post_type'=>'post', 
    'format'=>'html' 
));
    
print_r($my_archives); 
?>

最近 12 ヵ月

この 12 ヵ月の月別アーカイブリストを表示します。投稿のない月は表示しません。

<ul><?php wp_get_archives( 'type=monthly&limit=12' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'monthly', 'limit' => 12 ) ); ?></ul>

最近 16 日

この 16日の日別アーカイブリストを表示します。

<ul><?php wp_get_archives( 'type=daily&limit=16' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'daily', 'limit' => 16 ) ); ?></ul>

最近の投稿 20 件

最新 20 件の投稿記事タイトルの一覧を表示します。

<ul><?php wp_get_archives( 'type=postbypost&limit=20&format=custom' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'postbypost', 'limit' => 20, 'format' => 'custom' ) ); ?></ul>

月別アーカイブのドロップダウンボックス(ドロップダウンメニュー)を表示、各選択肢に投稿数を表示します。

<select name="archive-dropdown" onChange='document.location.href=this.options[this.selectedIndex].value;'> 
  <option value=""><?php echo attribute_escape(__('Select Month')); ?></option> 
  <?php wp_get_archives( 'type=monthly&format=option&show_post_count=1' ); ?>
</select>

または

<select name="archive-dropdown" onchange="document.location.href=this.options[this.selectedIndex].value;">
  <option value=""><?php echo esc_attr( __( 'Select Month' ) ); ?></option> 
  <?php wp_get_archives( array( 'type' => 'monthly', 'format' => 'option', 'show_post_count' => 1 ) ); ?>
</select>

すべての投稿をアルファベット順に

すべての投稿をアルファベット順に表示します。サイトマップ風のアーカイブ表示になります。

<?php wp_get_archives( 'type=alpha' ); ?>

参考

get_archives_link() を呼び出して、一つ一つのアーカイブリンクの文字列を組み立てます。

変更履歴

  • 4.4.0: 'post_type'パラメータを追加しました。
  • 3.5.0 : 'order' パラメータを追加しました。
  • 1.2.0 : 新規導入。

ソースファイル

wp_get_archives()wp-includes/general-template.php にあります。

リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


テンプレートタグへのクエリ文字列型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_get_archives最新版との差分