is_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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。