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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。