wp_revisions_to_keep

説明

int wp_revisions_to_keep( WP_Post $post )
投稿情報のリビジョン数を取得する。

パラメータ

  • $post
    投稿情報を指定。

返り値

投稿情報のリビジョン数を返す。


注意

保持するリビジョン数(数値またはtrue)を定義する WP_POST_REVISIONSを参照している。この定数がwp-config.php内で定義されている場合はその値が有効となり、定義されていない場合はtrueが定義される。WP_POST_REVISIONSがtrueの場合、この関数内ではリビジョン数が-1となる。

パラメータ$postの投稿タイプが'revisions'をサポートしていない場合、リビジョン数はWP_POST_REVISIONSの値に関わらず0となる。

[5.8.0]'wp_revisions_to_keep'フィルターの後に"wp_{$post->post_type}_revisions_to_keep"フィルター('wp_post_revisions_to_keep'や'wp_page_revisions_to_keep'など)が追加される。


使用例

  • 投稿情報のリビジョン数を取得する。
    $num = wp_revisions_to_keep( $post );

フィルター

[3.6.0]リビジョン数を返す前に'wp_revisions_to_keep'フィルターを呼び出す。パラメータ$numにはリビジョン数が、$postには本関数が受け取った内容が格納されている。
return (int) $num = apply_filters( 'wp_revisions_to_keep', $num, $post );
[5.8.0]'wp_revisions_to_keep'フィルターの後に"wp_{$post->post_type}_revisions_to_keep"フィルターを呼び出す。パラメータ$numにはリビジョン数が、$postには本関数が受け取った内容が格納されている。
$num = apply_filters( "wp_{$post->post_type}_revisions_to_keep", $num, $post );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/revision.php

最終更新 : 2021年07月27日 10:04



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

oEmbed対応サイトを整理した(2020年4月6日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。

使っていないか確認しないとね!(2022年6月7日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。