web-dev-qa-db-ja.com

hook_menu()アクセスコールバックの例はありますか?

examples プロジェクトをダウンロードしましたが、menu_exampleモジュールではすべてのaccess callbacktrue ..に設定されています。

私の例では、自分のmenoエントリはノード上に表示されますが、自分のノードを編集する権限を持つロールに対してのみです。

アクセスコールバックのもう少し詳細な例が見つかりません。

誰か持っていますか?

18
Strae

編集:「自分のノードの編集」権限に関する部分を逃しました。それは、権限を確認するだけでなく、そのノードが現在のユーザーに属しているかどうかも確認する必要があるためです。以下の例を更新しましたが、上記の説明はそのままにしておきます。

メニューエントリはnode/nid(例:node/1234/something)の下にありますか?そうすれば、おそらくカスタムアクセスコールバックも必要ありません。

次の例のようにメニューパスを定義すると、有効なノードを表示している場合にのみ、アクセスコールバック(したがってページコールバック)が呼び出されます。

_'node/%node/something'
_

つまり、上記の例ではnode_load(1234)を呼び出し、有効なノードオブジェクトが返された場合にのみ続行します。したがって、通常どおり、アクセス引数を使用して権限を定義できます。

とはいえ、アクセスコールバックの記述は非常に簡単です。これは、アクセス引数で定義した引数を受け取る関数です。たとえば、デフォルトのアクセスコールバックは ser_access() であり、'access arguments' => array('a permission string')のようなアクセス引数を定義すると、user_access('a permission string')が呼び出されます。

複数の引数がある場合、これらは関数の2番目、3番目などの引数として渡されます。現在アクティブなノードにアクセスするには、 menu_get_object() を使用できます。

したがって、このようにアクセスコールバックを記述できますが、ここでも作成する必要はありません。

_function yourmodule_access_check() {
  global $user;
  $node = menu_get_object();

  return $node && $node->uid == $user->uid && user_access('edit own ' . $node->type . ' content');
}
_

パーミッション文字列をハードコーディングする代わりに、関数または必要なものに引数として渡すことができます。

12
Berdir

Drupal自体がコードの記述方法の例です。

簡単な例は aggregator_menu() で、次のコードが含まれています。

  $items['admin/config/services/aggregator'] = array(
    'title' => 'Feed aggregator', 
    'description' => "Configure which content your site aggregates from other sites, how often it polls them, and how they're categorized.", 
    'page callback' => 'aggregator_admin_overview', 
    'access arguments' => array('administer news feeds'), 
    'weight' => 10, 
    'file' => 'aggregator.admin.inc',
  );
  $items['admin/config/services/aggregator/add/feed'] = array(
    'title' => 'Add feed', 
    'page callback' => 'drupal_get_form', 
    'page arguments' => array('aggregator_form_feed'), 
    'access arguments' => array('administer news feeds'), 
    'type' => MENU_LOCAL_ACTION, 
    'file' => 'aggregator.admin.inc',
  );

この場合、アクセスコールバックがデフォルト( ser_access() )であり、アクセス引数はアクセス許可の文字列を含む配列です。コードは許可以上のものをチェックすることはできません。チェックするアクセス許可が2つである場合、またはチェックする条件が単なるアクセス許可ではない場合、アクセスコールバックはカスタムのものを含め、別のものにする必要があります。

node_menu() デフォルトとは異なるアクセスコールバックを使用するいくつかのメニューを定義します。この関数には次のコードが含まれています。

  foreach (node_type_get_types() as $type) {
    $type_url_str = str_replace('_', '-', $type->type);
    $items['node/add/' . $type_url_str] = array(
      'title' => $type->name, 
      'title callback' => 'check_plain', 
      'page callback' => 'node_add', 
      'page arguments' => array($type->type), 
      'access callback' => 'node_access', 
      'access arguments' => array('create', $type->type), 
      'description' => $type->description, 
      'file' => 'node.pages.inc',
    );
  }

アクセスコールバック( node_access() )として定義されている関数は次のとおりです。

function node_access($op, $node, $account = NULL) {
  $rights = &drupal_static(__FUNCTION__, array());

  if (!$node || !in_array($op, array('view', 'update', 'delete', 'create'), TRUE)) {
    // If there was no node to check against, or the $op was not one of the
    // supported ones, we return access denied.
    return FALSE;
  }
  // If no user object is supplied, the access check is for the current user.
  if (empty($account)) {
    $account = $GLOBALS['user'];
  }

  // $node may be either an object or a node type. Since node types cannot be
  // an integer, use either nid or type as the static cache id.

  $cid = is_object($node) ? $node->nid : $node;

  // If we've already checked access for this node, user and op, return from
  // cache.
  if (isset($rights[$account->uid][$cid][$op])) {
    return $rights[$account->uid][$cid][$op];
  }

  if (user_access('bypass node access', $account)) {
    $rights[$account->uid][$cid][$op] = TRUE;
    return TRUE;
  }
  if (!user_access('access content', $account)) {
    $rights[$account->uid][$cid][$op] = FALSE;
    return FALSE;
  }

  // We grant access to the node if both of the following conditions are met:
  // - No modules say to deny access.
  // - At least one module says to grant access.
  // If no module specified either allow or deny, we fall back to the
  // node_access table.
  $access = module_invoke_all('node_access', $node, $op, $account);
  if (in_array(NODE_ACCESS_DENY, $access, TRUE)) {
    $rights[$account->uid][$cid][$op] = FALSE;
    return FALSE;
  }
  elseif (in_array(NODE_ACCESS_ALLOW, $access, TRUE)) {
    $rights[$account->uid][$cid][$op] = TRUE;
    return TRUE;
  }

  // Check if authors can view their own unpublished nodes.
  if ($op == 'view' && !$node->status && user_access('view own unpublished content', $account) && $account->uid == $node->uid && $account->uid != 0) {
    $rights[$account->uid][$cid][$op] = TRUE;
    return TRUE;
  }

  // If the module did not override the access rights, use those set in the
  // node_access table.
  if ($op != 'create' && $node->nid) {
    if (module_implements('node_grants')) {
      $query = db_select('node_access');
      $query->addExpression('1');
      $query->condition('grant_' . $op, 1, '>=');
      $nids = db_or()->condition('nid', $node->nid);
      if ($node->status) {
        $nids->condition('nid', 0);
      }
      $query->condition($nids);
      $query->range(0, 1);

      $grants = db_or();
      foreach (node_access_grants($op, $account) as $realm => $gids) {
        foreach ($gids as $gid) {
          $grants->condition(db_and()
            ->condition('gid', $gid)
            ->condition('realm', $realm)
          );
        }
      }
      if (count($grants) > 0) {
        $query->condition($grants);
      }
      $result =  (bool) $query
        ->execute()
        ->fetchField();
      $rights[$account->uid][$cid][$op] = $result;
      return $result;
    }
    elseif (is_object($node) && $op == 'view' && $node->status) {
      // If no modules implement hook_node_grants(), the default behavior is to
      // allow all users to view published nodes, so reflect that here.
      $rights[$account->uid][$cid][$op] = TRUE;
      return TRUE;
    }
  }

  return FALSE;
}

注意すべき点が3つあります。

  • 「アクセス引数」で宣言された引数は、同じ順序で関数に渡されます。この関数はアクセスコールバックだけでは使用されないため、3番目のパラメーターを使用します。
  • この関数は、ユーザーがメニューにアクセスできる場合はTRUEを返し、ユーザーがメニューにアクセスできない場合はFALSEを返します。
  • アクセスコールバックは、特定の状況でのみメニューを表示する必要がある場合にも使用できます。
19
kiamlaluno