Wordpress Manager

🚀 WordPress プラグイン開発ガイド

このガイドは、WordPress プラグインのインストール、設定、開発に関する詳細な手順を提供します。開発者はこのガイドを参考に、スムーズにプラグインの開発を進めることができます。

🚀 クイックスタート

このセクションでは、WordPress プラグインのインストールと基本的な設定方法を説明します。

インストール手順

1. WordPress 管理画面にログインします。
2. プラグイン > 新規追加 を選択します。
3. 検索バーにプラグイン名を入力し、「今すぐインストール」をクリックします。
4. インストールが完了したら、「有効化」をクリックしてプラグインを有効にします。

設定ガイド

• WordPress 管理画面のプラグイン設定ページを開きます。
• 必要な設定項目（API キー、シークレットキーなど）を入力します。
• 設定を保存すると、設定が完了します。

✨ 主な機能

このセクションでは、WordPress プラグインの主要な機能モジュールについて説明します。

記事管理

記事リストの取得

• 機能説明: 指定された条件に基づいて記事リストを返します。
• パラメータ説明:
  • perPage: 1 ページに表示する記事数（デフォルトは 10）。
  • page: 現在のページ番号（デフォルトは 1）。
  • searchTerm: 検索キーワード。

新しい記事の作成

• 機能説明: WordPress に新しい記事を追加します。
• 必須パラメータ:
  • title: 記事のタイトル。
  • content: 記事の内容。
  • customFields: カスタムフィールドのデータ。

メディア管理

メディアファイルリストの取得

• 機能説明: 指定された条件に基づいてメディアファイルリストを返します。
• オプションパラメータ:
  • mediaType: メディアタイプ（画像、動画など）。
  • searchTerm: 検索キーワード。

新しいメディアファイルの追加

• 機能説明: 新しいメディアファイルを WordPress にアップロードして保存します。
• 必須パラメータ:
  • file: アップロードするファイルのパスまたはバイナリデータ。
  • fileName: ファイル名（カスタマイズ可能）。
  • description: ファイルの説明情報。

カテゴリ管理

カテゴリリストの取得

• 機能説明: すべての WordPress カテゴリ情報を返します。
• パラメータ説明:
  • perPage: 1 ページに表示するカテゴリ数（デフォルトは 10）。
  • page: 現在のページ番号（デフォルトは 1）。

新しいカテゴリの作成

• 機能説明: 新しい WordPress カテゴリを追加します。
• 必須パラメータ:
  • categoryName: カテゴリ名。
  • customData: オプションの追加データ（カテゴリ説明、親カテゴリ ID など）。

カスタムリクエスト

カスタムリクエストの送信

• 機能説明: 任意の WordPress REST API リクエストを送信できます。
• 必須パラメータ:
  • siteUrl: サイトの URL アドレス。
  • username: WordPress のユーザー名。
  • password: ユーザーのパスワード。
• オプションパラメータ:
  • customEndpoint: カスタムリクエストのパス（例: /wp/v2/posts）。
  • customMethod: リクエストメソッド（デフォルトは GET、POST、PUT、DELETE をサポート）。
  • customData: POST または PUT リクエストのボディデータ。
  • customParams: URL クエリパラメータ。

例

{
  "tool": "custom_request",
  "siteUrl": "https://example.com",
  "username": "admin",
  "password": "your_password_here",
  "customEndpoint": "/wp/v2/posts/123",
  "customMethod": "DELETE"
}

📚 ドキュメント

レスポンス形式

データ構造

• 成功レスポンス:

  {
    "status": "success",
    "data": {...},
    "message": "操作成功"
  }
  

• 失敗レスポンス:

  {
    "status": "error",
    "code": "404",
    "message": "資源が見つかりません"
  }
  

ページネーションとソート

• カスタムページネーションとソート機能をサポートします。
• orderBy と orderDirection パラメータを使用して、返される結果の順序を制御できます。

セキュリティに関する考慮事項

基本的なセキュリティ対策

1. WordPress のコアプログラムとプラグインを常に最新バージョンに保ちます。
2. 簡単なパスワードの使用を避け、強力なパスワードポリシーを採用することをお勧めします。
3. 定期的にサイトデータをバックアップして、万が一の事態に備えます。

アプリケーションパスワードの管理

• WordPress のアプリケーションパスワード機能を使用して、セキュリティを強化します。
• アプリケーションパスワードを使用すると、特定のアプリケーションに制限されたアクセス権を付与でき、メインユーザーパスワードを共有する必要がありません。

開発と貢献

コード提出の規則

1. Git のバージョン管理フローに従い、コードの提出が明確で追跡可能なようにします。
2. Pull Request で変更内容と目的を詳細に説明します。
3. ユニットテストのカバレッジが基準を満たし、すべての自動検証を通過することを確認します。

貢献ガイド

• コミュニティの開発者の皆様からの貢献を歓迎します。
• 変更を提案する前に、プロジェクトのドキュメントとコード規約を読んでください。

📄 ライセンス

• MIT License: 自由な使用、変更、配布が許可されますが、著作権表示を保持する必要があります。
• GPL v3.0: オープンソースライセンスに従って二次開発と公開を行います。

以上のガイドを参考にすることで、WordPress プラグインのインストール、設定、開発を簡単に始めることができます。さらなるサポートが必要な場合は、公式ドキュメントを参照するか、コミュニティの開発者にお問い合わせください。