スパイラルPHPライブラリリファレンス(PHPdoc)に記載のない関数の一覧
最終更新日:2026年07月21日
本ページでは、スパイラルPHPライブラリリファレンス(PHPdoc)に記載のない関数をご案内いたします。
※本ページに記載のPHP関数は、スパイラル ver.1.14.14でリリース予定です。
getTfaSetupStatus()
[ 仕様 ]
マイエリアにログインしたユーザーの二段階認証の設定状態を取得して、ステータスの文字列を返します。
[ この関数が使える場所 ]
・フォーム(マイエリアのカスタムページにフォームのソースコードを記述している場合)
※フォームの「セキュリティ」「マイエリア認証によるアクセス制限」を「制限する」に設定してもフォームのページでは使用不可
・マイエリア
・カスタムページ
・メンバー情報ページ
・パスキーデバイスページ
・パスワード変更ページ
・一覧表・単票
・集計表・グラフ
・掲示板
・カスタムモジュール
[ サンプル ]
<?php
$result = $SPIRAL->getTfaSetupStatus();
?>
Tags:
return: 二段階認証の設定状態(ステータス)
・unavailable :マイエリアの二段階認証が「使用しない」に設定されている。または、この関数が使える場所以外で実行された場合。
・incomplete :マイエリアの二段階認証が「使用する」に設定されているが、ログインユーザーの二段階認証設定が未完了。
・complete :マイエリアの二段階認証が「使用する」に設定されている。(二段階認証のスキップ設定が有効な場合を含む)
access: private
Parameters:
不要
redirectToKeyword()
[ 仕様 ]
マイエリアに関連するページの差替えキーワードを指定して、任意のページへリダイレクトすることができます。
※現在リダイレクト先に指定できるページの差替えキーワードは、マイエリアのセッションが有効なページのみです。
※本スパイラルPHP関数によるリダイレクト処理は、HTMLソースの先頭に記述してください。
HTMLタグやテキストを出力した後にリダイレクト処理を実行した場合、正常にリダイレクトできず、以下のエラーが発生します。
「HTML出力後はリダイレクトできません。リダイレクト処理は、ソースコードの先頭行に記述してください。」
[ この関数が使える場所 ]
・フォーム(マイエリアのカスタムページにフォームのソースコードを記述している場合)
※フォームの「セキュリティ」「マイエリア認証によるアクセス制限」を「制限する」に設定してもフォームのページでは使用不可
・マイエリア
・カスタムページ
・メンバー情報ページ
・パスキーデバイスページ
・パスワード変更ページ
・一覧表・単票(アクセス権限がマイエリアに設定されている場合)
・集計表・グラフ(アクセス権限がマイエリアに設定されている場合)
・掲示板(アクセス権限がマイエリアに設定されている場合)
・カスタムモジュール(マイエリアのログインセッションが有効なページで呼び出す場合)
[ この関数で発生するエラー例 ]
▼固定のエラーページが表示されます。エラーページは編集することができません。
・エラーコード:1125
・エラーメッセージ:ページのリダイレクトに失敗しました
・フォームのページ上で実行した場合、フォームの設定画面でプレビューを表示した場合
・エラーコード:3130
・エラーメッセージ:ページのリダイレクトに失敗しました
・リダイレクト先に指定した差替えキーワードを正しく差替えることができない場合(差替えキーワードの値に誤りがある等)
・マイエリア外のページで実行した場合(マイエリアのログインページ等)
・マイエリアの設定画面でプレビューを表示した場合
・エラーコード:3411
・エラーメッセージ:ページが見つかりません
・既に削除済みのカスタムページをリダイレクト先に指定した場合
▼マイエリアのログインページの上部にエラーメッセージが表示されます。
・エラーメッセージ:セッションが切れています。再度ログインして下さい。
・リダイレクト先に指定したページへのアクセス権限がない場合(ログインしているマイエリアとは別のマイエリアのページ等)
[ サンプル ]
<?php
$SPIRAL->redirectToKeyword("%url/rel:tfa:setting%");
?>
Tags:
access: private
Parameters:
string $_Keyword リダイレクト先のページの差替えキーワード
※差替えキーワードの前後にパラメータ等の文字列は使用できません。
※指定可能なページの差替えキーワードは以下です。
・マイエリア
・二段階認証設定ページ
・ログイン後トップページ
・カスタムページ
・メンバー情報ページ
・パスキーデバイスページ
・パスワード変更ページ
・一覧表
・集計表・グラフ
・掲示板
redirectTo()
[ 仕様 ]
httpsを含むURLを指定して、任意のページへリダイレクトすることができます。
※本スパイラルPHP関数によるリダイレクト処理は、HTMLソースの先頭に記述してください。
HTMLタグやテキストを出力した後にリダイレクト処理を実行した場合、正常にリダイレクトできず、以下のエラーが発生します。
「HTML出力後はリダイレクトできません。リダイレクト処理は、ソースコードの先頭行に記述してください。」
[ この関数が使える場所 ]
PHPに対応したページならどこでも使用できます。
※プレビュー画面でもリダイレクトが実行されます。
[ サンプル ]
<?php
$SPIRAL->redirectTo("https://example.com/");
?>
Tags:
access: public
Parameters:
string $_url リダイレクト先のURL(httpsを含む、正しい形式のURLのみ許可)
※指定できるURLには以下の制限があります。
・URLの形式は、httpsから始まるURLを指定してください。
httpsをURLの先頭ではなく途中に含んでいる場合、リダイレクトされずに以下のエラーが発生します。
「HTTPSのみサポートしています。HTTPSから始まるURLを指定してください。」
・URLの文字数は、最大2048byteまでのURLを指定してください。
2049byte以上のURLを指定した場合、リダイレクトされずに以下のエラーが発生します。
「URLは 2048 文字以内で指定してください。 at line xx」
・URLの文字種は、大文字、小文字のアルファベット、数字、記号が使用可能です。
マルチバイト文字は使用できません。マルチバイト文字の部分を%エンコードして指定してください。

