is_sticky

（2.7.0以降）
is_sticky - 投稿が「先頭に固定表示（sticky）」か調べる

説明

bool is_sticky( [ int $post_id = 0 ] )
投稿が「先頭に固定表示（sticky）」か調べる。

パラメータ

  • $post_id
    投稿IDを指定（省略時は0）。

返り値

対象の投稿が「先頭に固定表示（sticky）」の場合はtrueを、それ以外はfalseを返す。

注意

パラメータ$post_idの省略時（0の場合）、 get_the_ID関数にて現在の投稿情報のIDを取得している。

使用例

  • 現在の投稿記事がstickyか調べる。
    <?php if ( is_sticky() ) : ?>
  • $postの投稿記事がstickyか調べる。
    <?php if ( is_sticky( $post->ID ) ) : ?>

フィルター

[5.3.0]判定結果を返す前に'is_sticky'フィルターを呼び出す。パラメータ$is_stickyには判定結果が、$post_idには本関数が受け取った投稿IDが格納されている。 
return apply_filters( 'is_sticky', $is_sticky, $post_id );

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2019年11月19日 14:39

関連

参考

Code Reference: is_sticky

お勧め

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。